RequestOptions

public protocol RequestOptions

Protocol for baseline options for individual client API calls.

  • A client-generated, opaque value with 1KB character limit that is recorded in analytics logs. Highly recommended for correlating client-side activites with requests received by the server.

    Declaration

    Swift

    var clientRequestId: String? { get }

  • A token used to make a best-effort attempt at canceling a request.

    Declaration

    Swift

    var cancellationToken: CancellationToken? { get }

  • A dispatch queue on which to call the completion handler. Defaults to DispatchQueue.main.

    Declaration

    Swift

    var dispatchQueue: DispatchQueue? { get }

  • A PipelineContext object to associate with the request.

    Declaration

    Swift

    var context: PipelineContext? { get set }