Uploadable

public protocol Uploadable: _AUploadable, Configurable, DataResponseSerializable

Represents an abstract Uploadable for Restofire.

Instead implement FileUploadable, DataUploadable, StreamUploadable, MultipartUplodable protocols.

  • request(_:didDownloadProgress:) Default implementation

    Called when the Request updates with download progress.

    Default Implementation

    Does Nothing

    Declaration

    Swift

    func request(_ request: UploadRequest, didDownloadProgress progress: Progress)

    Parameters

    request

    The Alamofire.UploadRequest

    progress

    The Progress

  • request(_:didUploadProgress:) Default implementation

    Called when the Request updates with upload progress.

    Default Implementation

    Does Nothing

    Declaration

    Swift

    func request(_ request: UploadRequest, didUploadProgress progress: Progress)

    Parameters

    request

    The Alamofire.UploadRequest

    progress

    The Progress

  • request(_:didCompleteWithValue:) Default implementation

    Called when the Request succeeds.

    Default Implementation

    Does Nothing

    Declaration

    Swift

    func request(_ request: UploadRequest, didCompleteWithValue value: Response)

    Parameters

    request

    The Alamofire.UploadRequest

    value

    The Response

  • request(_:didFailWithError:) Default implementation

    Called when the Request fails

    Default Implementation

    Does Nothing

    Declaration

    Swift

    func request(_ request: UploadRequest, didFailWithError error: Error)

    Parameters

    request

    The Alamofire.UploadRequest

    error

    The Error

  • response(_:) Extension method

    Creates a UploadOperation for the specified Uploadable object and asynchronously executes it.

    Declaration

    Swift

    public func response(_ completionHandler: ((DataResponse<Response>) -> Void)? = nil) -> UploadOperation<Self>

    Parameters

    completionHandler

    A closure to be executed once the download has finished. nil by default.

    Return Value

    The created UploadOperation.