QueryEvent

public class QueryEvent : CommunicationEvent<QueryEventData>

QueryEvent provides a generic implementation for querying CoatyObjects.

Static Factory Methods.

  • Create a QueryEvent instance for querying the given object types, filter, and join conditions. The object filter and join conditions are optional.

    Declaration

    Swift

    public static func with(objectTypes: [String],

                        objectFilter: ObjectFilter? = nil,

                        objectJoinConditions: [ObjectJoinCondition]? = nil) -> QueryEvent

    Parameters

    objectTypes

    restrict results by object types (logical OR).
    objectFilter

    restrict results by object filter (optional).
    objectJoinConditions

    join related objects into results (optional).

    Return Value

    a Query event with the given parameters

  • Create a QueryEvent instance for querying the given core types, filter, and join conditions. The object filter and join conditions are optional.

    Declaration

    Swift

    public static func with(coreTypes: [CoreType],

                        objectFilter: ObjectFilter? = nil,

                        objectJoinConditions: [ObjectJoinCondition]? = nil) -> QueryEvent

    Parameters

    coreTypes

    restrict results by core types (logical OR).
    objectFilter

    restrict results by object filter (optional).
    objectJoinConditions

    join related objects into results (optional).

    Return Value

    a Query event with the given parameters

  • Respond to a Query event with the given Retrieve event.

    Declaration

    Swift

    public func retrieve(retrieveEvent: RetrieveEvent)

    Parameters

    retrieveEvent

    a Retrieve event.

Codable methods.

  • Undocumented

    Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Undocumented

    Declaration

    Swift

    override public func encode(to encoder: Encoder) throws