GCKGameManagerChannel クラス

GCKGameManagerChannel クラス リファレンス

概要

ゲーム コントロール オペレーションの GCKCastChannel サブクラス。

デリゲート プロトコルについては、GCKGameManagerChannelDelegate をご覧ください。

Deprecated:
Game Manager API のサポートは終了しました。今後のリリースで削除される予定です。

GCKCastChannel を継承します。

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

(instancetype) - initWithSessionID:
 指定されたイニシャライザ。その他...
 
(instancetype) - init
 デフォルトのイニシャライザは使用できません。その他...
 
(NSInteger) - sendPlayerAvailableRequest:
 このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStateAvailable 状態になるようリクエストを送信します。その他...
 
(NSInteger) - sendPlayerAvailableRequest:playerID:
 レシーバにリクエストを送信して、プレーヤーを GCKPlayerStateAvailable 状態にします。その他...
 
(NSInteger) - sendPlayerReadyRequest:
 このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStateReady 状態になるようリクエストを送信します。その他...
 
(NSInteger) - sendPlayerReadyRequest:playerID:
 レシーバにリクエストを送信して、プレーヤーを GCKPlayerStateReady 状態にします。その他...
 
(NSInteger) - sendPlayerPlayingRequest:
 このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStatePlaying 状態になるようリクエストを送信します。その他...
 
(NSInteger) - sendPlayerPlayingRequest:playerID:
 レシーバにリクエストを送信して、プレーヤーを GCKPlayerStatePlaying 状態にします。その他...
 
(NSInteger) - sendPlayerIdleRequest:
 このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStateIdle 状態になるようリクエストを送信します。その他...
 
(NSInteger) - sendPlayerIdleRequest:playerID:
 レシーバにリクエストを送信して、プレーヤーを GCKPlayerStateIdle 状態にします。その他...
 
(NSInteger) - sendPlayerQuitRequest:
 このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStateQuit 状態になるようリクエストを送信します。その他...
 
(NSInteger) - sendPlayerQuitRequest:playerID:
 レシーバにリクエストを送信して、プレーヤーを GCKPlayerStateQuit 状態にします。その他...
 
(NSInteger) - sendGameRequest:
 ゲーム固有のメッセージをレシーバに送信します。その他...
 
(NSInteger) - sendGameRequest:playerID:
 ゲーム固有のメッセージをレシーバに送信します。その他...
 
(void) - sendGameMessage:
 ゲーム固有のメッセージをレシーバに送信します。その他...
 
(void) - sendGameMessage:playerID:
 ゲーム固有のメッセージをレシーバに送信します。その他...
 
(instancetype) - initWithNamespace:
 指定されたイニシャライザ。その他...
 
(void) - didReceiveTextMessage:
 このチャンネルでテキスト メッセージを受信すると呼び出されます。その他...
 
(BOOL) - sendTextMessage:
 このチャンネルでテキスト メッセージを送信します。その他...
 
(BOOL) - sendTextMessage:error:
 このチャンネルでテキスト メッセージを送信します。その他...
 
(NSInteger) - generateRequestID
 新しいメッセージのリクエスト ID を生成します。その他...
 
(NSNumber *__nullable) - generateRequestNumber
 generateRequestID の結果を NSNumber でラップする便利なメソッド。その他...
 
(void) - didConnect
 このチャンネルが接続されたときに呼び出されます。このチャンネルでキャスト デバイスとメッセージを送受信できます。その他...
 
(void) - didDisconnect
 このチャンネルの接続が解除されたときに呼び出されます。現在はこのチャンネルでキャスト デバイスとメッセージを交換できないことを示します。その他...
 

プロパティの概要

id< GCKGameManagerChannelDelegatedelegate
 GCKGameManagerChannel から通知を受け取るためのデリゲート。その他...
 
GCKGameManagerStatecurrentState
 ゲーム マネージャーの現在の状態。その他...
 
NSString * lastUsedPlayerID
 このセッションで最後に使用されたコントロール可能なプレーヤー ID です。その他...
 
BOOL isInitialConnectionEstablished
 チャンネルと受信者のゲーム マネージャーが接続されているかどうか。その他...
 
NSString * protocolNamespace
 チャンネルの名前空間。その他...
 
BOOL isConnected
 このチャンネルが現在接続されているかどうかを示すフラグ。その他...
 
GCKDeviceManagerdeviceManager
 チャンネルが登録されているデバイス マネージャー(ある場合)。その他...
 

メソッドの詳細

- (instancetype) initWithSessionID: (NSString *)  castSessionID

指定されたイニシャライザ。

受信者のゲーム マネージャーに自動的に接続します。

Parameters
castSessionIDThe Session ID corresponding to the currently connected Game Manager.
- (instancetype) init

デフォルトのイニシャライザは使用できません。

GCKCastChannel を実装します。

- (NSInteger) sendPlayerAvailableRequest: (id __nullable)  extraData

このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStateAvailable 状態になるようリクエストを送信します。

このプレーヤーが有効な移行でない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。最後に使用したプレーヤーがいない場合は、新しいプレーヤーが登録され、そのプレーヤー ID がこのリクエストに応答すると、最後に使用したプレーヤー ID として設定されます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

関連ドキュメント
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendPlayerAvailableRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

レシーバにリクエストを送信して、プレーヤーを GCKPlayerStateAvailable 状態にします。

このプレーヤーが有効な移行でない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。プレーヤー ID が nil の場合、新しいプレーヤーが登録され、プレーヤー ID がこのリクエストに応答すると、最後に使用されたプレーヤー ID として設定されます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player whose state is to be changed.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendPlayerReadyRequest: (id __nullable)  extraData

このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStateReady 状態になるようリクエストを送信します。

このプレーヤーが有効な移行でない場合、または最後に使用されたプレーヤー ID がない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

関連ドキュメント
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendPlayerReadyRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

レシーバにリクエストを送信して、プレーヤーを GCKPlayerStateReady 状態にします。

このプレーヤーが有効な移行でない場合、または最後に使用されたプレーヤー ID がない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player to change the state.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendPlayerPlayingRequest: (id __nullable)  extraData

このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStatePlaying 状態になるようリクエストを送信します。

このプレーヤーが有効な移行でない場合、または最後に使用されたプレーヤー ID がない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

関連ドキュメント
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendPlayerPlayingRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

レシーバにリクエストを送信して、プレーヤーを GCKPlayerStatePlaying 状態にします。

このプレーヤーが有効な移行でない場合、または最後に使用されたプレーヤー ID がない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player to change the state.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendPlayerIdleRequest: (id __nullable)  extraData

このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStateIdle 状態になるようリクエストを送信します。

このプレーヤーが有効な移行でない場合、または最後に使用されたプレーヤー ID がない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がレシーバのゲーム マネージャーにまだ接続されていない場合、GCKGameManagerChannel::gameManagerChannel:requestDoesFailWithID:error: デリゲート コールバックにメッセージを送信します。

関連ドキュメント
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendPlayerIdleRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

レシーバにリクエストを送信して、プレーヤーを GCKPlayerStateIdle 状態にします。

このプレーヤーが有効な移行でない場合、または最後に使用されたプレーヤー ID がない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player to change the state.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendPlayerQuitRequest: (id __nullable)  extraData

このレシーバに、この送信者が最後に使用したプレーヤーが GCKPlayerStateQuit 状態になるようリクエストを送信します。

このプレーヤーが有効な移行でない場合、または最後に使用されたプレーヤー ID がない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

関連ドキュメント
lastUsedPlayerID
Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendPlayerQuitRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

レシーバにリクエストを送信して、プレーヤーを GCKPlayerStateQuit 状態にします。

このプレーヤーが有効な移行でない場合、または最後に使用されたプレーヤー ID がない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだレシーバのゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe player ID of the player to change the state.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendGameRequest: (id __nullable)  extraData

ゲーム固有のメッセージをレシーバに送信します。

メッセージの内容は完全にアプリケーション次第です。このメッセージは lastUsedPlayerID から送信されています。レシーバーは、GCKGameManagerChannelDelegate を介してこの送信者にレスポンスを返します。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだレシーバー GameManager に接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (NSInteger) sendGameRequest: (id __nullable)  extraData
playerID: (NSString *)  playerID 

ゲーム固有のメッセージをレシーバに送信します。

メッセージの内容は完全にアプリケーション次第です。このメッセージは playerID から送信されています。playerIDnil の場合、lastUsedPlayerID が使用されます。レシーバーは、GCKGameManagerChannelDelegate を介してこの送信者にレスポンスを返します。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe id of the controllable player sending this message.
戻り値
リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID
- (void) sendGameMessage: (id __nullable)  extraData

ゲーム固有のメッセージをレシーバに送信します。

メッセージの内容は完全にアプリケーション次第です。このメッセージは lastUsedPlayerID から送信されています。これは、メッセージが送信されたことを保証せず、受信者がこの送信者にレスポンスを返信しないファイア アンド フォーゲット方式です。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
- (void) sendGameMessage: (id __nullable)  extraData
playerID: (NSString *)  playerID 

ゲーム固有のメッセージをレシーバに送信します。

このメッセージの内容は、すべてアプリケーション次第です。メッセージは、指定したローカル プレーヤー ID から発信されます。これはメッセージ送信が保証されておらず、受信者がこの送信者にレスポンスを返信しないファイア アンド フォーゲット方式です。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージを送信された場合にのみ呼び出す必要があります。GCKGameManagerChannel がまだ受信者のゲーム マネージャーに接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters
extraDataCustom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerIDThe ID of the controllable player sending this message.
- (instancetype) initWithNamespace: (NSString *)  protocolNamespace

指定されたイニシャライザ。

指定された名前空間を使用して新しい GCKCastChannel を作成します。

Parameters
protocolNamespaceThe namespace.

GCKGenericChannel で実装。

- (void) didReceiveTextMessage: (NSString *)  message

このチャンネルでテキスト メッセージを受信すると呼び出されます。

デフォルトの実装は NoOps です。

Parameters
messageThe message.
- (BOOL) sendTextMessage: (NSString *)  message

このチャンネルでテキスト メッセージを送信します。

Parameters
messageThe message.
戻り値
YES(成功の場合)、またはメッセージを送信できなかった場合は NO(チャンネルが接続されていないか、現在送信バッファがいっぱいになっているため)。
Deprecated:
詳細なエラー情報を提供する sendTextMessage:error: を使用します。
- (BOOL) sendTextMessage: (NSString *)  message
error: (GCKError *__nullable *__nullable)  error 

このチャンネルでテキスト メッセージを送信します。

Parameters
messageThe message.
errorA pointer at which to store the error result. May be nil.
戻り値
成功の場合は
YES、メッセージを送信できなかった場合はNO
- (NSInteger) generateRequestID

新しいメッセージのリクエスト ID を生成します。

戻り値
生成された ID。チャンネルが現在接続されていない場合は kGCKInvalidRequestID
- (NSNumber * __nullable) generateRequestNumber

generateRequestID の結果を NSNumber でラップする便利なメソッド。

戻り値
生成された ID。チャンネルが現在接続されていない場合は nil
- (void) didConnect

このチャンネルが接続されたときに呼び出されます。このチャンネルでキャスト デバイスとメッセージを送受信できます。

デフォルトの実装は NoOps です。

- (void) didDisconnect

このチャンネルの接続が解除されたときに呼び出されます。現在はこのチャンネルでキャスト デバイスとメッセージを交換できないことを示します。

デフォルトの実装は NoOps です。

プロパティの詳細

- (id<GCKGameManagerChannelDelegate>) delegate
readwritenonatomicweak

GCKGameManagerChannel から通知を受け取るためのデリゲート。

- (GCKGameManagerState*) currentState
readnonatomicstrong

ゲーム マネージャーの現在の状態。

- (NSString*) lastUsedPlayerID
readnonatomiccopy

このセッションで最後に使用されたコントロール可能なプレーヤー ID です。

レシーバーに制御可能なプレーヤーが設定されていない場合は、nil になります。

関連ドキュメント
- sendPlayerAvailableRequest:
- (BOOL) isInitialConnectionEstablished
readnonatomicassign

チャンネルと受信者のゲーム マネージャーが接続されているかどうか。

このメソッドは、このチャンネルの作成時点から NO を返します。

戻り値
YESこのチャンネルが受信側のゲームマネージャーに接続されていて、操作できる状態になっている場合。NOそれ以外の場合は
- (NSString*) protocolNamespace
readnonatomiccopyinherited

チャンネルの名前空間。

- (BOOL) isConnected
readnonatomicassigninherited

このチャンネルが現在接続されているかどうかを示すフラグ。

- (GCKDeviceManager*) deviceManager
readnonatomicweakinherited

チャンネルが登録されているデバイス マネージャー(ある場合)。

Deprecated:
このチャンネルが非推奨の GCKDeviceManager クラスに登録されていない場合、これは nil になります。