GCKRequest Class
-
A GCKRequest object tracks an asynchronous request.
-
The GCKRequestDelegate protocol handles notifications about the request status.
-
Requests can be canceled, completed, failed with an error, or aborted with a reason.
-
Applications can create and manage their own GCKRequest objects using the applicationRequest class method.
-
Key properties include the delegate, a unique request ID, the error if it failed, the inProgress status, and whether the request is external.
An object for tracking an asynchronous request.
See GCKRequestDelegate for the delegate protocol.
- Since
- 3.0
Inherits NSObject.
Instance Method Summary | |
| (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... | |
Property Summary | |
| 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... | |
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.
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
-
error The error describing the failure.
- Since
- 3.4
| - (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
-
reason The reason for the abort.
- Since
- 3.4
The delegate for receiving notifications about the status of the request.
|
- (GCKRequestID) requestID |
readnonatomicassign |
The unique ID assigned to this request.
The error that caused the request to fail, if any, otherwise nil.
A flag indicating whether the request is currently in progress.
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