Request Class Reference


                    
                    task

The underlying task.

Declaration

Swift

public var task: NSURLSessionTask { get }

Show on GitHub


                    
                    Serializer

A closure used by response handlers that takes a request, response, and data and returns a serialized object and any error that occured in the process.

Declaration

Swift

public typealias Serializer = (NSURLRequest, NSHTTPURLResponse?, NSData?) -> (AnyObject?, NSError?)

Show on GitHub


                    
                    session

The session belonging to the underlying task.

Declaration

Swift

public let session: NSURLSession

Show on GitHub


                    
                    request

The request sent or to be sent to the server.

Declaration

Swift

public var request: NSURLRequest { get }

Show on GitHub


                    
                    response

The response received from the server, if any.

Declaration

Swift

public var response: NSHTTPURLResponse? { get }

Show on GitHub


                    
                    progress

The progress of the request lifecycle.

Declaration

Swift

public var progress: NSProgress? { get }

Show on GitHub


                    
                    authenticate(user:password:)

Associates an HTTP Basic credential with the request.

Declaration

Swift

public func authenticate(#user: String, password: String) -> Self

Parameters

`user`	The user.
`password`	The password.

Return Value

The request.

Show on GitHub


                    
                    authenticate(usingCredential:)

Associates a specified credential with the request.

Declaration

Swift

public func authenticate(usingCredential credential: NSURLCredential) -> Self

Parameters


                                credential

The credential.

Return Value

The request.

Show on GitHub


                    
                    progress(closure:)

Sets a closure to be called periodically during the lifecycle of the request as data is written to or read from the server.

For uploads, the progress closure returns the bytes written, total bytes written, and total bytes expected to write.
For downloads, the progress closure returns the bytes read, total bytes read, and total bytes expected to write.

Declaration

Swift

public func progress(closure: ((Int64, Int64, Int64) -> Void)? = default) -> Self

Parameters


                                closure

The code to be executed periodically during the lifecycle of the request.

Return Value

The request.

Show on GitHub


                    
                    responseDataSerializer()

Creates a response serializer that returns the associated data as-is.

Declaration

Swift

public class func responseDataSerializer() -> Serializer

Return Value

A data response serializer.

Show on GitHub


                    
                    response(_:)

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

Declaration

Swift

public func response(completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -> Void) -> Self

Parameters


                                completionHandler

The code to be executed once the request has finished.

Return Value

The request.

Show on GitHub


                    
                    response(queue:serializer:completionHandler:)

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

Declaration

Swift

public func response(queue: dispatch_queue_t? = default, serializer: Serializer, completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -> Void) -> Self

Parameters

`queue`	The queue on which the completion handler is dispatched.
`serializer`	The closure responsible for serializing the request, response, and data.
`completionHandler`	The code to be executed once the request has finished.

Return Value

The request.

Show on GitHub


                    
                    suspend()

Suspends the request.

Declaration

Swift

public func suspend()

Show on GitHub


                    
                    resume()

Resumes the request.

Declaration

Swift

public func resume()

Show on GitHub


                    
                    cancel()

Cancels the request.

Declaration

Swift

public func cancel()

Show on GitHub