QueryOptions

public struct QueryOptions

Options related to the API request.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • Declaration

    Swift

    public init
    (
        extras: [String: String]? = nil,
        customEndpoint: URL? = nil,
        trackingId: String? = nil
    )

    Parameters

    extras

    A collection of key-value pairs that should be included in the request.
    customEndpoint

    The server to send the request to.
    trackingId

    An ID for tracking this client’s requests.

Public

  • A collection of key-value pairs that should be included in the request.

    Declaration

    Swift

    public let extras: [String : String]?

  • The server to send the request to.

    Declaration

    Swift

    public let customEndpoint: URL?

  • An ID for tracking this client’s requests.

    Declaration

    Swift

    public let trackingId: String?

QueryOptions

  • Copies the current QueryOptions with changes specified in build closure

    Declaration

    Swift

    public func copy(build: (inout Builder) -> ()) -> QueryOptions

    Parameters

    build

    This closure allows for change of QueryOptions values

    Return Value

    QueryOptions with the changes set on the closure

  • The Builder creates a new instance of QueryOptions with modified fields.

    Declaration

    Swift

    public struct Builder