Protocols

The following protocols are available globally.

  • Protocol that allows a route’s ID or UUID values to be used interchangeably when accessing API endpoints.

    Declaration

    Swift

    public protocol UserRouteServerIdentifier : CustomStringConvertible

  • Requirements for types that can be converted to and from milliseconds.

    See more

    Declaration

    Swift

    public protocol MillisecondsRepresentable

  • Undocumented

    Declaration

    Swift

    public protocol SearchInputCriteria : Encodable

  • Token that can be used to sign relevant requests as the user it represents.

    See more

    Declaration

    Swift

    public protocol AccessToken : CustomDebugStringConvertible, CustomStringConvertible, Decodable, Encodable

Multipart data convertible

  • Protocol to convert objects to data for inclusion in a multipart POST body.

    See more

    Declaration

    Swift

    public protocol MultipartDataConvertible

  • Undocumented

    See more

    Declaration

    Swift

    public protocol PendingRequest : NSObjectProtocol

  • Protocol defining the requirements for parameters used for requests.

    See more

    Declaration

    Swift

    public protocol RequestBody

  • Protocol defining internal endpoints accepted when generating requests for the API. These endpoints contain relative uris and need to be wrapped by a RequestEndpoint to add server baseURL

    See more

    Declaration

    Swift

    public protocol InternalRequestEndpoint

  • Protocol defining server endpoints with a url

    See more

    Declaration

    Swift

    public protocol RequestEndpoint : InternalRequestEndpoint