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:: |
特定の Player の |
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 に、タイムアウトを 10 年として呼び出すのと同じになります。
FetchBlocking
FetchResponse FetchBlocking( DataSource data_source, const std::string & player_id )
特定のプレーヤーのすべてのデータを同期的に読み込み、FetchResponse を直接返します。
data_source を CACHE_OR_NETWORK または NETWORK_ONLY として指定します。タイムアウトを指定しないと、この関数呼び出しは FetchResponse FetchBlocking(DataSource data_source, Timeout timeout) を、指定した data_source 値で指定し、タイムアウトを 10 年として呼び出すのと同じになります。
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 で指定され、タイムアウトに指定した値が含まれるようになります。
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 オブジェクトを返す場合があり、その場合、Player.HasLevelInfo は false を返します。そのような場合は、Fetch API を使用して特定のプレーヤーを再度リクエストすることで、レベルの情報を取得できます。 非推奨。
FetchConnected
void FetchConnected( FetchListCallback callback )
CACHE_OR_NETWORK のデフォルトの data_source を使用する FetchConnected のオーバーロード。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking( DataSource data_Source, Timeout timeout )
FetchConnected のブロック バージョン。
呼び出し元がタイムアウトをミリ秒単位で指定できます。指定した時間が経過すると、関数は ERROR_TIMEOUT
を返します。なお、iOS では、このブロック バージョンを UI スレッドから呼び出すことはできません。データを提供する基盤となる Plus サービスでは、UI スレッドでオペレーションを実行する必要があるからです。
非推奨。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking( DataSource data_source )
デフォルトのタイムアウトである 10 年を使用する FetchConnectedBlocking のオーバーロード。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking( Timeout timeout )
CACHE_OR_NETWORK のデフォルトの data_source を使用する 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 オブジェクトを返す場合があり、その場合、Player.HasLevelInfo は false を返します。そのような場合は、Fetch API を使用して特定のプレーヤーを再度リクエストすることで、レベルの情報を取得できます。 非推奨。
FetchInvitable
void FetchInvitable( FetchListCallback callback )
CACHE_OR_NETWORK のデフォルトの data_source を使用する FetchInvitable のオーバーロード。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking( DataSource data_source, Timeout timeout )
FetchInvitable のブロック バージョン。
呼び出し元がタイムアウトをミリ秒単位で指定できます。指定した時間が経過すると、関数は ERROR_TIMEOUT
を返します。なお、iOS では、このブロック バージョンを UI スレッドから呼び出すことはできません。データを提供する基盤となる Plus サービスでは、UI スレッドでオペレーションを実行する必要があるからです。
非推奨。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking( DataSource data_source )
デフォルトのタイムアウトである 10 年を使用する FetchInvitableBlocking のオーバーロード。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking( Timeout timeout )
CACHE_OR_NETWORK のデフォルトの data_source を使用する 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 )
CACHE_OR_NETWORK のデフォルトの data_source を使用する 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 を指定しないと、この関数の呼び出しは FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout) の呼び出しと同等になります。その際、data_source を CACHE_OR_NETWORK に、timeout を 10 年として指定します。
FetchSelfBlocking
FetchSelfResponse FetchSelfBlocking( DataSource data_source )
現在ログインしているすべてのプレーヤーのすべてのデータを同期的に読み込み、FetchSelfResponse を直接返します。
data_source を CACHE_OR_NETWORK または NETWORK_ONLY として指定します。タイムアウトを指定しないと、この関数の呼び出しは FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout) を、指定した data_source 値に指定し、タイムアウトを 10 年として呼び出すのと同じになります。
FetchSelfBlocking
FetchSelfResponse FetchSelfBlocking( Timeout timeout )
現在ログインしているすべてのプレーヤーのすべてのデータを同期的に読み込み、FetchSelfResponse を直接返します。
タイムアウトを任意のミリ秒数で指定します。data_source を指定しないと、この関数の呼び出しは、data_source を CACHE_OR_NETWORK に指定し、タイムアウトに指定された値を指定して、FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout) を呼び出すのと同等になります。
FetchSelfBlocking
FetchSelfResponse FetchSelfBlocking( DataSource data_source, Timeout timeout )
現在ログインしているすべてのプレーヤーのすべてのデータを同期的に読み込み、FetchSelfResponse を直接返します。
data_source を CACHE_OR_NETWORK または NETWORK_ONLY として指定します。タイムアウトを任意のミリ秒数で指定します。