QueryParams

public struct QueryParams: Encodable

Data type to specify filters for querying records

  • Initializer to specify filters for querying records

    Declaration

    Swift

    public init(
    count: Int? = nil,
    includeData: Bool? = nil,
    writerIds: [UUID]? = nil,
    userIds: [UUID]? = nil,
    recordIds: [UUID]? = nil,
    types: [String]? = nil,
    after: Double? = nil,
    includeAllWriters: Bool? = nil
)

    Parameters

    count

    Limit the number of records returned by the query beyond the E3db default
    includeData

    Supply the full decrypted record set in the results
    writerIds

    Filter to records written by these IDs
    userIds

    Filter to records with these user IDs
    recordIds

    Filter to only the records identified by these IDs
    contentTypes

    Filter to records that match the given types
    after

    Number to facilitate paging the results – used with the last property of the QueryResponse
    includeAllWriters

    Set this flag to include records that have been shared with you, defaults to false

  • Advance the query beyond the given value, leaving other parameters unchanged.

    Declaration

    Swift

    public func next(after: Double) -> QueryParams

    Parameters

    after

    The value to start the results query

    Return Value

    A new QueryParams object initialized with existing parameters and a new starting value

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws