UsherAPIRequest

public class UsherAPIRequest : APIRequestType

This class conforms to APIRequestType and provides some more functionality of its own specific to Usher Server APIs. Use this along with UsherAPITask to make calls to Usher Server API endpoints.

  • UsherAPIRequestJSONCompletion

    The closure used by responseJSON(_ completion:) -> APIRequestType request completion callback.

    Declaration

    Swift

    public typealias UsherAPIRequestJSONCompletion = (_ json: JSON?, _ error: UsherErrorProtocol?) -> ()
  • responseValidator

    Custom response validation closure. Default implementation exists.

    Declaration

    Swift

    public var responseValidator: Alamofire.DataRequest.Validation? { get }
  • dataCompletions

    Container to store the closures.

    Declaration

    Swift

    public var dataCompletions: [APIRequestType.APIRequestDataCompletion]
  • id

    A unique ID for the request.

    Declaration

    Swift

    public var id: UUID
  • executionBehavior

    The executing behavior.

    Declaration

    Swift

    public var executionBehavior: <<error type>>
  • completionQueue

    A queue to turn the completion of the request on. Default is DispatchQueue.main. Default implementation exists.

    Declaration

    Swift

    public var completionQueue: DispatchQueue
  • timeline

    An Alamofire Timeline object for obtaining the timing metrics for the complete lifecycle of the request.

    Declaration

    Swift

    public var timeline: Timeline?
  • error

    An error that resulted from the API call execution.

    Declaration

    Swift

    public var error: UsherErrorProtocol?
  • server

    The server to use for this request. Defaults to ServerManager.defaultServer()

    Declaration

    Swift

    public lazy var server: Server? { get set }
  • device

    The device to use for this request. Defaults to Device.deviceForServer(ServerManager.defaultServer())

    Declaration

    Swift

    public lazy var device: Device? { get set }
  • status

    The status of the API request execution. See APIRequestStatus for values.

    Declaration

    Swift

    public var status: APIRequestStatus
  • config

    The configuration of type APIRequestConfigurationType.

    Declaration

    Swift

    public var config: APIRequestConfigurationType
  • init(for:)

    Convenience API to directly initialize for one of the predefined Usher server API endpoints.

    See also

    UsherAPITask
    Declaration

    Swift

    public convenience init(for task: UsherAPITask)
  • init(with:)

    Initialize with UsherAPIRequestConfiguration

    See also

    UsherAPIRequestConfiguration
    Declaration

    Swift

    public required init(with config: UsherAPIRequestConfiguration)
  • responseJSON(_:)

    A completion callback providing JSON object generated from the server response.

    See also

    UsherAPIRequestJSONCompletion
    Declaration

    Swift

    @discardableResult
public func responseJSON(_ completion: @escaping UsherAPIRequestJSONCompletion) -> APIRequestType
  • responseValidation()

    Undocumented

    Declaration

    Swift

    func responseValidation() -> Alamofire.DataRequest.Validation
  • recreateSessionManager()

    Undocumented

    Declaration

    Swift

    static func recreateSessionManager()