Instance Methods | Class Methods | Properties | List of all members
GCKRequest Class Reference

An object for tracking an asynchronous request. More...

#import <GCKRequest.h>

+ Inheritance diagram for GCKRequest:

Instance Methods

(void) - cancel
 Cancels the request. More...
 
(void) - complete
 Completes the request and notifies the delegate accordingly. More...
 
(void) - failWithError:
 Fails the request with an error and notifies the delegate accordingly. More...
 
(void) - abortWithReason:
 Aborts the request with a reason and notifies the delegate accordingly. More...
 

Class Methods

(GCKRequest *) + applicationRequest
 Constructs a GCKRequest object for use by the calling application. More...
 

Properties

id< GCKRequestDelegate > delegate
 The delegate for receiving notifications about the status of the request. More...
 
GCKRequestID requestID
 The unique ID assigned to this request. More...
 
GCKError * error
 The error that caused the request to fail, if any, otherwise nil. More...
 
BOOL inProgress
 A flag indicating whether the request is currently in progress. More...
 
BOOL external
 A flag indicating whether this is an external request–that is, one created by the application rather than by the framework itself. More...
 

Detailed Description

An object for tracking an asynchronous request.

See GCKRequestDelegate for the delegate protocol.

Since
3.0

Method Documentation

- (void) abortWithReason: (GCKRequestAbortReason)  reason

Aborts the request with a reason and notifies the delegate accordingly.

This method may only be called on GCKRequest objects that have been constructed by the application using the GCKRequest::requestWithID: factory method. Calling this method on a GCKRequest object that was created by the framework itself will raise an exception.

Parameters
reasonThe reason for the abort.
Since
3.4
+ (GCKRequest *) applicationRequest

Constructs a GCKRequest object for use by the calling application.

Request objects created using this factory method can be managed by the application using the methods complete, failWithError:, and abortWithReason:.

Since
3.4
- (void) cancel

Cancels the request.

Canceling a request does not guarantee that the request will not complete on the receiver; it simply causes the sender to stop tracking the request.

- (void) complete

Completes the request and notifies the delegate accordingly.

This method may only be called on GCKRequest objects that have been constructed by the application using the applicationRequest factory method. Calling this method on a GCKRequest object that was created by the framework itself will raise an exception.

Since
3.4
- (void) failWithError: (GCKError *)  error

Fails the request with an error and notifies the delegate accordingly.

This method may only be called on GCKRequest objects that have been constructed by the application using the GCKRequest::requestWithID: factory method. Calling this method on a GCKRequest object that was created by the framework itself will raise an exception.

Parameters
errorThe error describing the failure.
Since
3.4

Property Documentation

- (id<GCKRequestDelegate>) delegate
readwritenonatomicweak

The delegate for receiving notifications about the status of the request.

- (GCKError*) error
readnonatomiccopy

The error that caused the request to fail, if any, otherwise nil.

- (BOOL) external
readnonatomicassign

A flag indicating whether this is an external request–that is, one created by the application rather than by the framework itself.

Since
3.4
- (BOOL) inProgress
readnonatomicassign

A flag indicating whether the request is currently in progress.

- (GCKRequestID) requestID
readnonatomicassign

The unique ID assigned to this request.

The documentation for this class was generated from the following file: