DataRequest Class Reference

Properties

progress
The progress of fetching the response data from the server for the request.
Declaration
Swift

open var progress: Progress
Show on GitHub

Stream

stream(closure:)
Sets a closure to be called periodically during the lifecycle of the request as data is read from the server.

This closure returns the bytes most recently received from the server, not including data from previous calls. If this closure is set, data will only be available within this closure, and will not be saved elsewhere. It is also important to note that the server data in any Response object will be nil.
Declaration
Swift

open func stream(closure: ((Data) -> Void)? = nil) -> Self
Show on GitHub

Progress

downloadProgress(queue:closure:)
Sets a closure to be called periodically during the lifecycle of the Request as data is read from the server.
Declaration
Swift

open func downloadProgress(queue: DispatchQueue = DispatchQueue.main, closure: @escaping ProgressHandler) -> Self
Show on GitHub

addAcceptableImageContentTypes(_:)
Adds the content types specified to the list of acceptable images content types for validation.
Declaration
Swift

public class func addAcceptableImageContentTypes(_ contentTypes: Set<String>)
Show on GitHub

iOS, tvOS and watchOS


                    
                    
                    imageResponseSerializer(imageScale:inflateResponseImage:)

Creates a response serializer that returns an image initialized from the response data using the specified image options.

Declaration

Swift

public class func imageResponseSerializer(
        imageScale: CGFloat = DataRequest.imageScale,
        inflateResponseImage: Bool = true)
        -> DataResponseSerializer<Image>

Show on GitHub


                    
                    
                    responseImage(imageScale:inflateResponseImage:completionHandler:)

Adds a handler to be called once the request has finished.

Declaration

Swift

public func responseImage(
        imageScale: CGFloat = DataRequest.imageScale,
        inflateResponseImage: Bool = true,
        completionHandler: @escaping (DataResponse<Image>) -> Void)
        -> Self

Show on GitHub


                    
                    
                    response(queue:completionHandler:)

Adds a handler to be called once the request has finished.

Declaration

Swift

public func response(queue: DispatchQueue? = nil, completionHandler: @escaping (DefaultDataResponse) -> Void) -> Self

Show on GitHub


                    
                    
                    response(queue:responseSerializer:completionHandler:)

Adds a handler to be called once the request has finished.

Declaration

Swift

public func response<T: DataResponseSerializerProtocol>(
        queue: DispatchQueue? = nil,
        responseSerializer: T,
        completionHandler: @escaping (DataResponse<T.SerializedObject>) -> Void)
        -> Self

Show on GitHub

dataResponseSerializer()
Creates a response serializer that returns the associated data as-is.
Declaration
Swift

public static func dataResponseSerializer() -> DataResponseSerializer<Data>
Show on GitHub


                    
                    
                    responseData(queue:completionHandler:)

Adds a handler to be called once the request has finished.

Declaration

Swift

public func responseData(
        queue: DispatchQueue? = nil,
        completionHandler: @escaping (DataResponse<Data>) -> Void)
        -> Self

Show on GitHub

stringResponseSerializer(encoding:)
Creates a response serializer that returns a result string type initialized from the response data with the specified string encoding.
Declaration
Swift

public static func stringResponseSerializer(encoding: String.Encoding? = nil) -> DataResponseSerializer<String>
Show on GitHub


                    
                    
                    responseString(queue:encoding:completionHandler:)

Adds a handler to be called once the request has finished.

Declaration

Swift

public func responseString(
        queue: DispatchQueue? = nil,
        encoding: String.Encoding? = nil,
        completionHandler: @escaping (DataResponse<String>) -> Void)
        -> Self

Show on GitHub

jsonResponseSerializer(options:)
Creates a response serializer that returns a JSON object result type constructed from the response data using JSONSerialization with the specified reading options.
Declaration
Swift

public static func jsonResponseSerializer( options: JSONSerialization.ReadingOptions = .allowFragments) -> DataResponseSerializer<Any>
Show on GitHub


                    
                    
                    responseJSON(queue:options:completionHandler:)

Adds a handler to be called once the request has finished.

Declaration

Swift

public func responseJSON(
        queue: DispatchQueue? = nil,
        options: JSONSerialization.ReadingOptions = .allowFragments,
        completionHandler: @escaping (DataResponse<Any>) -> Void)
        -> Self

Show on GitHub

propertyListResponseSerializer(options:)
Creates a response serializer that returns an object constructed from the response data using PropertyListSerialization with the specified reading options.
Declaration
Swift

public static func propertyListResponseSerializer( options: PropertyListSerialization.ReadOptions = []) -> DataResponseSerializer<Any>
Show on GitHub


                    
                    
                    responsePropertyList(queue:options:completionHandler:)

Adds a handler to be called once the request has finished.

Declaration

Swift

public func responsePropertyList(
        queue: DispatchQueue? = nil,
        options: PropertyListSerialization.ReadOptions = [],
        completionHandler: @escaping (DataResponse<Any>) -> Void)
        -> Self

Show on GitHub

validate(_:)
Validates the request, using the specified closure.

If validation fails, subsequent calls to response handlers will have an associated error.
Declaration
Swift

public func validate(_ validation: @escaping Validation) -> Self
Show on GitHub
validate(statusCode:)
Validates that the response has a status code in the specified sequence.

If validation fails, subsequent calls to response handlers will have an associated error.
Declaration
Swift

public func validate<S: Sequence>(statusCode acceptableStatusCodes: S) -> Self where S.Iterator.Element == Int
Show on GitHub
validate(contentType:)
Validates that the response has a content type in the specified sequence.

If validation fails, subsequent calls to response handlers will have an associated error.
Declaration
Swift

public func validate<S: Sequence>(contentType acceptableContentTypes: S) -> Self where S.Iterator.Element == String
Show on GitHub
validate()
Validates that the response has a status code in the default acceptable range of 200…299, and that the content type matches any specified in the Accept HTTP header field.

If validation fails, subsequent calls to response handlers will have an associated error.
Declaration
Swift

public func validate() -> Self
Show on GitHub