OrderByProperty

public class OrderByProperty : Codable

Determines the ordering of result objects by an array of (property name, sort order) tuples. The results are ordered by the first tuple, then by the second tuple, etc.

  • The ordered collection of filter properties.

    Declaration

    Swift

    internal(set) public var objectFilterProperties: ObjectFilterProperty { get }

  • The sorting order.

    Declaration

    Swift

    internal(set) public var sortingOrder: SortingOrder { get }

  • Create an OrderByProperty instance.

    Declaration

    Swift

    public init(properties: ObjectFilterProperty,

            sortingOrder: SortingOrder)

    Parameters

    properties

    The object property used for ordering can be specified either in dot notation or array notation. In dot notation, the name of the object property is specified as a string (e.g. "objectId"). It may include dots (.) to access nested properties of subobjects (e.g. "message.name"). If a single property name contains dots itself, you obviously cannot use dot notation. Instead, specify the property or nested properties as an array of strings (e.g. ["property.with.dots", "subproperty.with.dots"]). -sortingOrder: Ascending or descending sort order.

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws