GCKRequest Class
Stay organized with collections
Save and categorize content based on your preferences.
An object for tracking an asynchronous request.
See GCKRequestDelegate
for the delegate protocol.
- Since
- 3.0
Inherits NSObject.
Completes the request and notifies the delegate accordingly. More...
Fails the request with an error and notifies the delegate accordingly. More...
Aborts the request with a reason and notifies the delegate accordingly. More...
The delegate for receiving notifications about the status of the request. More...
The unique ID assigned to this request. More...
The error that caused the request to fail, if any, otherwise nil
. More...
A flag indicating whether the request is currently in progress. More...
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
read
write
nonatomic
weak
The delegate for receiving notifications about the status of the request.
- (GCKRequestID) requestID
read
nonatomic
assign
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eGCKRequest\u003c/code\u003e class is used for tracking asynchronous requests made to a Google Cast device.\u003c/p\u003e\n"],["\u003cp\u003eApplications can create and manage their own \u003ccode\u003eGCKRequest\u003c/code\u003e objects, or they can use the framework-provided ones.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGCKRequest\u003c/code\u003e objects have a delegate that is notified of the request's progress and completion status.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eGCKRequest\u003c/code\u003e can be canceled, completed, failed, or aborted, depending on the outcome of the operation it is tracking.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eGCKRequest\u003c/code\u003e has a unique ID and properties indicating its progress, any associated errors, and whether it's an external request.\u003c/p\u003e\n"]]],["The GCKRequest class manages asynchronous requests, enabling tracking and control. Key actions include: canceling a request (`cancel`), completing it (`complete`), or failing it with an error (`failWithError:`) or a reason (`abortWithReason:`). Applications can create request objects using `applicationRequest`. Properties like `delegate`, `requestID`, `error`, `inProgress`, and `external` provide request status information. The delegate receives notifications about the request status. These request objects created by applications can be managed by the application using the methods complete, failWithError and abortWithReason.\n"],null,[]]
