POIAPIRequestBehaviour Protocol Reference


                    
                    
                    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: AnyPOIAPIRequest, urlRequest: URLRequest) -> URLRequest


                    
                    
                    validate(request:urlRequest:complete:)

Default implementation

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

Default Implementation

Declaration

Swift

func validate(request: AnyPOIAPIRequest, urlRequest: URLRequest, complete: @escaping (RequestValidationResult) -> Void)


                    
                    
                    beforeSend(request:)

Default implementation

called before request is sent

Default Implementation

Declaration

Swift

func beforeSend(request: AnyPOIAPIRequest)


                    
                    
                    onSuccess(request:result:)

Default implementation

called when request successfuly returns a 200 range response

Default Implementation

Declaration

Swift

func onSuccess(request: AnyPOIAPIRequest, 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: AnyPOIAPIRequest, 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: AnyPOIAPIRequest, response: AnyPOIAPIResponse)