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