RequestBehaviour

public protocol RequestBehaviour

Undocumented

  • modifyRequest(request:urlRequest:) Default implementation

    runs first and allows the requests to be modified. If modifying asynchronously use validate

    Default Implementation

    Declaration

    Swift

    func modifyRequest(request: AnyRequest, urlRequest: URLRequest) -> URLRequest

  • validates and modifies the request. complete must be called with either .success or .fail

    Default Implementation

    Declaration

    Swift

    func validate(request: AnyRequest, urlRequest: URLRequest, complete: @escaping (RequestValidationResult) -> Void)
  • beforeSend(request:) Default implementation

    called before request is sent

    Default Implementation

    Declaration

    Swift

    func beforeSend(request: AnyRequest)
  • onSuccess(request:result:) Default implementation

    called when request successfuly returns a 200 range response

    Default Implementation

    Declaration

    Swift

    func onSuccess(request: AnyRequest, result: Any)
  • onFailure(request:error:) Default implementation

    called when request fails with an error. This will not be called if the request returns a known response even if the a status code is out of the 200 range

    Default Implementation

    Declaration

    Swift

    func onFailure(request: AnyRequest, error: APIClientError)
  • onResponse(request:response:) Default implementation

    called if the request recieves a network response. This is not called if request fails validation or encoding

    Default Implementation

    Declaration

    Swift

    func onResponse(request: AnyRequest, response: AnyResponse)