gpg:: PlayerManager
#include <player_manager.h>
プレーヤーに関連するさまざまなデータを取得、設定します。
概要
パブリック タイプ |
|
---|---|
FetchCallback
|
typedefstd::function< void(const FetchResponse &)>
FetchResponse を受信するコールバック タイプを定義します。 |
FetchListCallback
|
typedefstd::function< void(const FetchListResponse &)>
FetchListResponse を受信するコールバック タイプを定義します。 |
FetchSelfCallback
|
typedefstd::function< void(const FetchSelfResponse &)>
FetchSelfResponse を受信するコールバック タイプを定義します。 |
構造体 |
|
---|---|
gpg:: |
プレーヤーのベクトルを含むレスポンス。 |
gpg:: |
|
gpg:: |
すべてのプレーヤーデータとレスポンス ステータスを保持します。 |
パブリック タイプ
FetchCallback
std::function< void(const FetchResponse &)> FetchCallback
FetchResponse を受信するコールバック タイプを定義します。
このコールバック タイプは、以下の Fetch(*)
関数に提供されます。
FetchListCallback
std::function< void(const FetchListResponse &)> FetchListCallback
FetchListResponse を受信するコールバック タイプを定義します。
このコールバック タイプは、以下の Fetch(*)
関数に提供されます。
FetchSelfCallback
std::function< void(const FetchSelfResponse &)> FetchSelfCallback
FetchSelfResponse を受信するコールバック タイプを定義します。
このコールバック タイプは、以下の FetchSelf(*)
関数に提供されます。
パブリック関数
取得
void Fetch( const std::string & player_id, FetchCallback callback )
特定のプレーヤーのすべてのデータを非同期で読み込みます。
オペレーションの完了時に指定された FetchCallback を呼び出します。data_source を指定しない場合、この関数呼び出しは、data_source が CACHE_OR_NETWORK として指定された Fetch(DataSource data_source, const std::string& player_id, FetchCallback callback)
の呼び出しと同等になります。
取得
void Fetch( DataSource data_source, const std::string & player_id, FetchCallback callback )
特定のプレーヤーのすべてのデータを非同期で読み込みます。
オペレーションの完了時に指定された FetchCallback を呼び出します。data_source を CACHE_OR_NETWORK または NETWORK_ONLY として指定します。
FetchBlocking
FetchResponse FetchBlocking( const std::string & player_id )
特定のプレーヤーのすべてのデータを同期的に読み込み、FetchResponse を直接返します。
data_source も timeout も指定しない場合、この関数呼び出しは、FetchResponse FetchBlocking(DataSource data_source, timeout timeout) を呼び出すことと同等になります。この場合、DataSource は CACHE_OR_NETWORK に、timeout は 10 年に指定します。
FetchBlocking
FetchResponse FetchBlocking( DataSource data_source, const std::string & player_id )
特定のプレーヤーのすべてのデータを同期的に読み込み、FetchResponse を直接返します。
data_source を CACHE_OR_NETWORK または NETWORK_ONLY として指定します。timeout を指定しない場合、この関数呼び出しは、指定した data_source 値と 10 年として指定された timeout を使用して FetchResponse FetchBlocking(DataSource data_source, Timeout timeout) を呼び出す場合と同じになります。
FetchBlocking
FetchResponse FetchBlocking( Timeout timeout, const std::string & player_id )
特定のプレーヤーのすべてのデータを同期的に読み込み、FetchResponse を直接返します。
タイムアウトを任意のミリ秒数で指定します。data_source を指定しない場合、この関数呼び出しは、FetchResponse FetchBlocking(DataSource data_source, Timeout timeout) の呼び出しと同等になります。この場合、data_source は CACHE_OR_NETWORK として指定され、timeout には指定した値が含まれます。
FetchBlocking
FetchResponse FetchBlocking( DataSource data_source, Timeout timeout, const std::string & player_id )
特定のプレーヤーのすべてのデータを同期的に読み込み、FetchResponse を直接返します。
data_source を CACHE_OR_NETWORK または NETWORK_ONLY として指定します。タイムアウトを任意のミリ秒数で指定します。
FetchConnected
void FetchConnected( DataSource data_source, FetchListCallback callback )
ログインしているプレーヤーが情報を取得する権限を持っている、現在のゲームに接続しているすべてのプレーヤーを非同期で読み込みます。
オペレーションの完了時に指定された FetchCallback を呼び出します。data_source を CACHE_OR_NETWORK または NETWORK_ONLY のいずれかに指定します。
この関数は、Player.HasLevelInfo が false を返す Player オブジェクトを返す場合があります。このような場合は、Fetch API を使用して特定のプレーヤーを再リクエストすることで、レベル情報を取得できます。 非推奨。
FetchConnected
void FetchConnected( FetchListCallback callback )
デフォルトの data_source として CACHE_OR_NETWORK を使用する FetchConnected のオーバーロード。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking( DataSource data_Source, Timeout timeout )
FetchConnected のブロック バージョン。
呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT
を返します。iOS では、データを提供する基盤となる Plus サービスが UI スレッドでオペレーションを実行する必要があるため、このブロッキング バージョンは UI スレッドから呼び出すことはできません。
非推奨。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking( DataSource data_source )
デフォルトのタイムアウトが 10 年になる FetchConnectedBlocking のオーバーロード。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking( Timeout timeout )
デフォルトの data_source として CACHE_OR_NETWORK を使用する FetchConnectedBlocking のオーバーロード。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking()
デフォルトの data_source が CACHE_OR_NETWORK で、デフォルトのタイムアウトが 10 年である FetchConnectedBlocking のオーバーロード。
FetchInvitable
void FetchInvitable( DataSource data_source, FetchListCallback callback )
ローカル プレーヤーのサークル内にあるすべてのプレーヤー(ローカル プレーヤーから招待を受けることができるプレーヤー)を非同期で読み込みます。
招待可能なプレーヤーが現在のゲームに接続していない場合、招待されたという通知が届かないことがあります。
オペレーションの完了時に指定された FetchCallback を呼び出します。data_source を CACHE_OR_NETWORK または NETWORK_ONLY のいずれかに指定します。
この関数は、Player.HasLevelInfo が false を返す場合に Player オブジェクトを返すことがあります。このような場合は、Fetch API を使用して特定のプレーヤーを再リクエストすることで、レベル情報を取得できます。 非推奨。
FetchInvitable
void FetchInvitable( FetchListCallback callback )
デフォルトの data_source として CACHE_OR_NETWORK を使用する FetchInvitable のオーバーロード。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking( DataSource data_source, Timeout timeout )
FetchInvitable のブロック バージョン。
呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT
を返します。iOS では、データを提供する基盤となる Plus サービスが UI スレッドでオペレーションを実行する必要があるため、このブロッキング バージョンは UI スレッドから呼び出すことはできません。
非推奨。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking( DataSource data_source )
デフォルトのタイムアウトが 10 年になる FetchInvitableBlocking のオーバーロード。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking( Timeout timeout )
デフォルトの data_source として CACHE_OR_NETWORK を使用する FetchInvitableBlocking のオーバーロード。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking()
デフォルトの data_source が CACHE_OR_NETWORK で、デフォルトのタイムアウトが 10 年である FetchInvitableBlocking のオーバーロード。
FetchRecentlyPlayed
void FetchRecentlyPlayed( DataSource data_source, FetchListCallback callback )
最近再生したすべてのプレーヤーを非同期で読み込みます。
オペレーションの完了時に指定された FetchCallback を呼び出します。data_source を CACHE_OR_NETWORK または NETWORK_ONLY のいずれかに指定します。
FetchRecentlyPlayed
void FetchRecentlyPlayed( FetchListCallback callback )
デフォルトの data_source として CACHE_OR_NETWORK を使用する FetchRecentlyPlayed のオーバーロード。
FetchRecentlyPlayedBlocking
FetchListResponse FetchRecentlyPlayedBlocking( DataSource data_source, Timeout timeout )
FetchRecentlyPlayed のブロック バージョン。
呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT
を返します。
FetchRecentlyPlayedBlocking
FetchListResponse FetchRecentlyPlayedBlocking( DataSource data_source )
デフォルトのタイムアウトが 10 年である FetchRecentlyPlayedBlocking のオーバーロード。
FetchRecentlyPlayedBlocking
FetchListResponse FetchRecentlyPlayedBlocking( Timeout timeout )
デフォルトの data_source として CACHE_OR_NETWORK を使用する FetchRecentlyPlayedBlocking のオーバーロード。
FetchRecentlyPlayedBlocking
FetchListResponse FetchRecentlyPlayedBlocking()
デフォルトの data_source が CACHE_OR_NETWORK で、デフォルトのタイムアウトが 10 年である FetchRecentlyPlayedBlocking のオーバーロード。
FetchSelf
void FetchSelf( FetchSelfCallback callback )
現在ログインしているすべてのプレーヤーのすべてのデータを非同期で読み込みます。
オペレーションの完了時に、指定された FetchSelfCallback を呼び出します。data_source を指定しない場合、この関数呼び出しは、data_source が CACHE_OR_NETWORK として指定された FetchSelf(DataSource data_source, FetchSelfCallback callback)
の呼び出しと同等になります。
FetchSelf
void FetchSelf( DataSource data_source, FetchSelfCallback callback )
現在ログインしているすべてのプレーヤーのすべてのデータを非同期で読み込みます。
オペレーションの完了時に、指定された FetchSelfCallback を呼び出します。data_source を CACHE_OR_NETWORK または NETWORK_ONLY として指定します。
FetchSelfBlocking
FetchSelfResponse FetchSelfBlocking()
現在ログインしているすべてのプレーヤーのすべてのデータを同期的に読み込み、FetchSelfResponse を直接返します。
data_source または timeout を指定しない場合、この関数呼び出しは、data_source を CACHE_OR_NETWORK として、timeout を 10 年として、FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout) を呼び出す場合と同等になります。
FetchSelfBlocking
FetchSelfResponse FetchSelfBlocking( DataSource data_source )
現在ログインしているすべてのプレーヤーのすべてのデータを同期的に読み込み、FetchSelfResponse を直接返します。
data_source を CACHE_OR_NETWORK または NETWORK_ONLY として指定します。タイムアウトを指定しない場合、この関数呼び出しは、指定した data_source 値と 10 年として指定されたタイムアウトで FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout) を呼び出すのと同等になります。
FetchSelfBlocking
FetchSelfResponse FetchSelfBlocking( Timeout timeout )
現在ログインしているすべてのプレーヤーのすべてのデータを同期的に読み込み、FetchSelfResponse を直接返します。
タイムアウトを任意のミリ秒数で指定します。data_source を指定しない場合、この関数呼び出しは、FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout) の呼び出しと同等になります。この場合、data_source は CACHE_OR_NETWORK として指定され、timeout には指定した値が含まれます。
FetchSelfBlocking
FetchSelfResponse FetchSelfBlocking( DataSource data_source, Timeout timeout )
現在ログインしているすべてのプレーヤーのすべてのデータを同期的に読み込み、FetchSelfResponse を直接返します。
data_source を CACHE_OR_NETWORK または NETWORK_ONLY として指定します。タイムアウトを任意のミリ秒数で指定します。