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