DiscoverEventData

public class DiscoverEventData : CommunicationEventData

DiscoverEventData provides the entire message payload data of a DiscoverEvent.

Attributes.

  • The external ID of the object(s) to be discovered or nil.

    Note

    externalId can be used exclusively or in combination with objectId property. Only if used exclusively it can be combined with objectTypes or coreTypes properties.

    Declaration

    Swift

    public var externalId: String?

  • The object UUID of the object to be discovered or nil.

    Note

    objectId can be used exclusively or in combination with externalId property. Must not be used in combination with objectTypes or coreTypes properties.

    Declaration

    Swift

    public var objectId: CoatyUUID?

  • Restrict objects by object types (logical OR).

    Note

    objectTypes must not be used with objectId property. Should not be used in combination with coreTypes.

    Declaration

    Swift

    public var objectTypes: [String]?

  • Restrict objects by core types (logical OR).

    Note

    coreTypes must not be used with objectId property. Should not be used in combination with objectTypes.

    Declaration

    Swift

    public var coreTypes: [CoreType]?

Convenience initializers that cover all permitted parameter combinations.

  • Determines whether the given CoreType is compatible with this event data.

    Declaration

    Swift

    public func isCoreTypeCompatible(_ coreType: CoreType) -> Bool

    Return Value

    true, if the specified core type is contained in the coreTypes property; false otherwise.

  • Determines whether the given ObjectType is compatible with this event data.

    Declaration

    Swift

    public func isObjectTypeCompatible(objectType: String) -> Bool

    Parameters

    objectType

    name of the object type to check

    Return Value

    true, if the specified type is contained in the objectTypes property; false otherwise.

  • Determines whether this event data discovers an object based on an object ID.

    Declaration

    Swift

    public func isDiscoveringObjectId() -> Bool

  • Determines whether this event data discovers an object based on an external ID but not an object ID.

    Declaration

    Swift

    public func isDiscoveringExternalId() -> Bool

  • Determines whether this event data discovers an object based on both external ID and object ID.

    Declaration

    Swift

    public func isDiscoveringExternalAndObjectId() -> Bool

  • Determines whether this event data discovers an object based on types only.

    Declaration

    Swift

    public func isDiscoveringTypes() -> Bool

Codable methods.

  • Undocumented

    Declaration

    Swift

    required public init(from decoder: Decoder) throws

  • Undocumented

    Declaration

    Swift

    public override func encode(to encoder: Encoder) throws