DiscoverEvent

public class DiscoverEvent : CommunicationEvent<DiscoverEventData>

DiscoverEvent provides a generic implementation for discovering CoatyObjects. Note that this class should preferably be initialized by its withObject() method.

Static Factory Methods.

  • Create a DiscoverEvent instance for discovering objects with the given external Id.

    Declaration

    Swift

    public static func with(externalId: String) -> DiscoverEvent

    Parameters

    externalId

    the external ID to discover

  • Create a DiscoverEvent instance for discovering objects with the given external Id and core types.

    Declaration

    Swift

    public static func with(externalId: String, coreTypes: [CoreType]) -> DiscoverEvent

    Parameters

    externalId

    the external ID to discover
    coreTypes

    an array of core types to discover

  • Create a DiscoverEvent instance for discovering objects with the given external Id and object types.

    Declaration

    Swift

    public static func with(externalId: String, objectTypes: [String]) -> DiscoverEvent

    Parameters

    externalId

    the external ID to discover.
    objectTypes

    an array of object types to discover.

  • Create a DiscoverEvent instance for discovering objects with the given object Id.

    Declaration

    Swift

    public static func with(objectId: CoatyUUID) -> DiscoverEvent

    Parameters

    objectId

    the object ID to discover

  • Create a DiscoverEvent instance for discovering objects with the given external Id and object Id.

    Declaration

    Swift

    public static func with(externalId: String,

                 objectId: CoatyUUID) -> DiscoverEvent

    Parameters

    externalId

    the external ID to discover
    objectId

    the object ID to discover

  • Create a DiscoverEvent instance for discovering objects with the given core types.

    Declaration

    Swift

    public static func with(coreTypes: [CoreType]) -> DiscoverEvent

    Parameters

    coreTypes

    coreTypes the core types to discover

  • Create a DiscoverEvent instance for discovering objects with the given object types.

    Declaration

    Swift

    public static func with(objectTypes: [String]) -> DiscoverEvent

    Parameters

    objectTypes

    the object types to discover

  • Respond to a Discover event with the given Resolve event.

    Declaration

    Swift

    public func resolve(resolveEvent: ResolveEvent)

    Parameters

    resolveEvent

    a Resolve event.

Codable methods.

  • Undocumented

    Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Undocumented

    Declaration

    Swift

    override public func encode(to encoder: Encoder) throws