DataRequest

public class DataRequest : Request

Undocumented

  • Undocumented

    Declaration

    Swift

    public let convertible: URLRequestConvertible

  • Undocumented

    Declaration

    Swift

    public var data: Data? { get }

  • Validates the request, using the specified closure.

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

    Declaration

    Swift

    @discardableResult
public func validate(_ validation: @escaping Validation) -> Self

    Parameters

    validation

    A closure to validate the request.

    Return Value

    The request.

Default

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

    Declaration

    Swift

    @discardableResult
public func response(queue: DispatchQueue = .main, completionHandler: @escaping (DataResponse<Data?>) -> Void) -> Self

    Parameters

    queue

    The queue on which the completion handler is dispatched. Defaults to .main.
    completionHandler

    The code to be executed once the request has finished.

    Return Value

    The request.

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

    Declaration

    Swift

    @discardableResult
public func response<Serializer: DataResponseSerializerProtocol>(
    queue: DispatchQueue = .main,
    responseSerializer: Serializer,
    completionHandler: @escaping (DataResponse<Serializer.SerializedObject>) -> Void)
    -> Self

    Parameters

    queue

    The queue on which the completion handler is dispatched. Defaults to .main.
    responseSerializer

    The response serializer responsible for serializing the request, response, and data.
    completionHandler

    The code to be executed once the request has finished.

    Return Value

    The request.

Data

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

    Declaration

    Swift

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

    Parameters

    queue

    The queue on which the completion handler is dispatched. Defaults to .main.
    completionHandler

    The code to be executed once the request has finished.

    Return Value

    The request.

String

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

    Declaration

    Swift

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

    Parameters

    queue

    The queue on which the completion handler is dispatched. Defaults to .main.
    encoding

    The string encoding. Defaults to nil, in which case the encoding will be determined from the server response, falling back to the default HTTP character set, ISO-8859-1.
    completionHandler

    A closure to be executed once the request has finished.

    Return Value

    The request.

JSON

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

    Declaration

    Swift

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

    Parameters

    queue

    The queue on which the completion handler is dispatched. Defaults to .main.
    options

    The JSON serialization reading options. Defaults to .allowFragments.
    completionHandler

    A closure to be executed once the request has finished.

    Return Value

    The request.

Decodable

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

    Declaration

    Swift

    @discardableResult
public func responseDecodable<T: Decodable>(queue: DispatchQueue = .main,
                                            decoder: DataDecoder = JSONDecoder(),
                                            completionHandler: @escaping (DataResponse<T>) -> Void) -> Self

    Parameters

    queue

    The queue on which the completion handler is dispatched. Defaults to .main.
    decoder

    The DataDecoder to use to decode the response. Defaults to a JSONDecoder with default settings.
    completionHandler

    A closure to be executed once the request has finished.

    Return Value

    The request.

  • A closure used to validate a request that takes a URL request, a URL response and data, and returns whether the request was valid.

    Declaration

    Swift

    public typealias Validation = (URLRequest?, HTTPURLResponse, Data?) -> ValidationResult

  • 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

    @discardableResult
public func validate<S>(statusCode acceptableStatusCodes: S) -> Self where S : Sequence, S.Element == Int

    Parameters

    range

    The range of acceptable status codes.

    Return Value

    The request.

  • 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

    @discardableResult
public func validate<S: Sequence>(contentType acceptableContentTypes: @escaping @autoclosure () -> S) -> Self where S.Iterator.Element == String

    Parameters

    contentType

    The acceptable content types, which may specify wildcard types and/or subtypes.

    Return Value

    The request.

  • 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

    @discardableResult
public func validate() -> Self

    Return Value

    The request.