GCKRequest クラス

インスタンス メソッド | クラスメソッド | プロパティ
GCKRequest クラス リファレンス

概要

非同期リクエストを追跡するためのオブジェクト。

委譲プロトコルについては、GCKRequestDelegate をご覧ください。

開始:
3.0

NSObject を継承します。

インスタンス メソッドの概要

(void) - cancel
 リクエストをキャンセルします。その他...
 
(void) - complete
 リクエストを完了し、それに応じて代理人に通知します。その他...
 
(void) - failWithError:
 リクエストをエラーで失敗させ、それに応じてデリゲートに通知します。その他...
 
(void) - abortWithReason:
 理由を指定してリクエストを中止し、それに応じて代理人に通知します。その他...
 

クラスメソッドの概要

(GCKRequest *) + applicationRequest
 呼び出し元アプリで使用する GCKRequest オブジェクトを作成します。その他...
 

プロパティの概要

id< GCKRequestDelegate > delegate
 リクエストのステータスに関する通知を受信するデリゲート。その他...
 
GCKRequestID requestID
 このリクエストに割り当てられた一意の ID。その他...
 
GCKError * error
 リクエストが失敗する原因となったエラー（存在する場合）。それ以外の場合は nil。その他...
 
BOOL inProgress
 リクエストが現在進行中かどうかを示すフラグ。その他...
 
BOOL external
 これが外部リクエスト（フレームワーク自体ではなくアプリケーションによって作成されたリクエスト）かどうかを示すフラグ。その他...
 

メソッドの詳細

- (void) cancel

リクエストをキャンセルします。

リクエストをキャンセルしても、そのリクエストが受信側で完了しないとは限りません。送信側がリクエストのトラッキングを停止するだけです。

+ (GCKRequest *) applicationRequest

呼び出し元アプリで使用する GCKRequest オブジェクトを作成します。

このファクトリ メソッドを使用して作成されたリクエスト オブジェクトは、メソッド complete、failWithError:、abortWithReason: を使用してアプリで管理できます。

開始:
3.4
- (void) complete

リクエストを完了し、それに応じて代理人に通知します。

このメソッドは、applicationRequest ファクトリ メソッドを使用してアプリが作成した GCKRequest オブジェクトに対してのみ呼び出すことができます。フレームワーク自体によって作成された GCKRequest オブジェクトでこのメソッドを呼び出すと、例外が発生します。

開始:
3.4
- (void) failWithError: (GCKError *)  error

リクエストをエラーで失敗させ、それに応じてデリゲートに通知します。

このメソッドは、GCKRequest::requestWithID: ファクトリ メソッドを使用してアプリによって作成された GCKRequest オブジェクトでのみ呼び出すことができます。フレームワーク自体によって作成された GCKRequest オブジェクトでこのメソッドを呼び出すと、例外が発生します。

Parameters
errorThe error describing the failure.
開始:
3.4
- (void) abortWithReason: (GCKRequestAbortReason)  reason

理由を指定してリクエストを中止し、それに応じて代理人に通知します。

このメソッドは、GCKRequest::requestWithID: ファクトリ メソッドを使用してアプリによって作成された GCKRequest オブジェクトでのみ呼び出すことができます。フレームワーク自体によって作成された GCKRequest オブジェクトでこのメソッドを呼び出すと、例外が発生します。

Parameters
reasonThe reason for the abort.
開始:
3.4

物件の詳細

- (id<GCKRequestDelegate>) delegate
readwritenonatomicweak

リクエストのステータスに関する通知を受信するデリゲート。

- (GCKRequestID) requestID
readnonatomicassign

このリクエストに割り当てられた一意の ID。

- (GCKError*) error
readnonatomiccopy

リクエストが失敗する原因となったエラー（存在する場合）。それ以外の場合は nil。

- (BOOL) inProgress
readnonatomicassign

リクエストが現在進行中かどうかを示すフラグ。

- (BOOL) external
readnonatomicassign

これが外部リクエスト（フレームワーク自体ではなくアプリケーションによって作成されたリクエスト）かどうかを示すフラグ。

開始:
3.4