CTR NEX API Reference
nn::nex::Ranking2Client クラス

Ranking2 機能を利用するためのクラス。 [詳解]

#include <RendezVous/Services/Jugem/Ranking2/src/Client/Ranking2Client.h>

+ nn::nex::Ranking2Client の継承関係図

公開メンバ関数

 Ranking2Client ()
 コンストラクタです。 [詳解]
 
virtual ~Ranking2Client ()
 デストラクタです。 [詳解]
 
virtual qBool Bind (Credentials *pCredentials)
 サービスを利用するための証明書を登録します。 [詳解]
 
qBool DeleteCommonData (ProtocolCallContext *pContext, UniqueId nexUniqueId=INVALID_UNIQUEID)
 ユーザー共通データを削除します。 [詳解]
 
qBool GetCategorySetting (ProtocolCallContext *pContext, qUnsignedInt32 category, Ranking2CategorySetting *pCategorySetting)
 カテゴリ設定を取得します。 [詳解]
 
qBool GetCommonData (ProtocolCallContext *pContext, Ranking2CommonData *pCommonData, qUnsignedInt32 optionFlags=0, PrincipalID principalId=INVALID_PRINCIPALID, UniqueId nexUniqueId=INVALID_UNIQUEID)
 ユーザー共通データを取得します。 [詳解]
 
CredentialsGetCredentials () const
 Bind() された Credentials オブジェクトを取得します。 [詳解]
 
qBool GetRanking (ProtocolCallContext *pContext, const Ranking2GetParam &getParam, Ranking2Info *pRankingInfo)
 ランキングを取得します。 [詳解]
 
qBool GetRanking (ProtocolCallContext *pContext, const Ranking2GetByListParam &getParam, const qVector< PrincipalID > &principalIdList, Ranking2Info *pRankingInfo)
 プリンシパル ID リストを用いてランキングを取得します。 [詳解]
 
qBool PutCommonData (ProtocolCallContext *pContext, const Ranking2CommonData &commonData, UniqueId nexUniqueId=INVALID_UNIQUEID)
 ユーザー共通データを登録します。 [詳解]
 
qBool PutScore (ProtocolCallContext *pContext, const Ranking2ScoreData &scoreData, UniqueId nexUniqueId=INVALID_UNIQUEID)
 スコアを登録します。 [詳解]
 
qBool PutScore (ProtocolCallContext *pContext, const qVector< Ranking2ScoreData > &scoreDataList, UniqueId nexUniqueId=INVALID_UNIQUEID)
 スコアを登録します。 [詳解]
 
void SetDefaultCredentials (Credentials *pCredentials)
 
virtual qBool Unbind ()
 証明書の登録を解除します。 [詳解]
 

詳解

Ranking2 機能を利用するためのクラス。

構築子と解体子

nn::nex::Ranking2Client::Ranking2Client ( )

コンストラクタです。

コンストラクタです。

virtual nn::nex::Ranking2Client::~Ranking2Client ( )
virtual

デストラクタです。

デストラクタです。

関数詳解

virtual qBool nn::nex::Ranking2Client::Bind ( Credentials pCredentials)
virtual

サービスを利用するための証明書を登録します。

サービスを利用するための証明書をセットします。 機能を利用する前にセットする必要があります。NgsFacade::Login() の非同期処理に成功後、 NgsFacade::GetCredentials() で取得した証明書を引数に指定してください。 Bind() で証明書をセットした後もう一度 Bind() を呼び出すと証明書を差し替える事ができます。

引数
[in]pCredentialsサービスにアクセスするための証明書。


戻り値一覧:

true 成功。pCredentials が NULL でない場合は必ず成功します。

false pCredentials に NULL が指定された。

nn::nex::ServiceClientを再実装しています。

virtual qBool nn::nex::Ranking2Client::Unbind ( )
virtual

証明書の登録を解除します。

Bind() でセットされた証明書を解除します。Bind() が呼び出されていなくても本関数を呼び出すことができます。 本オブジェクトを破棄する際に自動的に Unbind() が呼び出されるため、明示的に呼び出す必要はありません。


戻り値一覧:

true 証明書の解除を行った。

false Bind() が行われていないため何も行わなかった。

nn::nex::ServiceClientを再実装しています。

qBool nn::nex::Ranking2Client::PutScore ( ProtocolCallContext pContext,
const Ranking2ScoreData scoreData,
UniqueId  nexUniqueId = INVALID_UNIQUEID 
)

スコアを登録します。

1つのスコアを1つのカテゴリに登録します。 ログインしているユーザーのスコアのみを登録可能です。他のユーザーのスコアを登録することはできません。 カテゴリ設定で指定された正常範囲を外れたスコアが渡された場合は、ランキングには現れない場所に不正スコアとして隔離して保存されます。

非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]scoreDataスコアの情報。
[in]nexUniqueIdNEX ユニーク ID。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::Ranking2Client::PutScore ( ProtocolCallContext pContext,
const qVector< Ranking2ScoreData > &  scoreDataList,
UniqueId  nexUniqueId = INVALID_UNIQUEID 
)

スコアを登録します。

複数のスコアをそれぞれ別のカテゴリに登録します。 ログインしているユーザーのスコアのみを登録可能です。他のユーザーのスコアを登録することはできません。 同時に登録できるスコアの数は、最大 Ranking2Constants::MAX_PUT_MULTI_SCORES 個です。 カテゴリ設定で指定された正常範囲を外れたスコアが渡された場合は、ランキングには現れない場所に不正スコアとして隔離して保存されます。 正常範囲に収まるスコアと外れるスコアが混在している場合は、正常範囲に収まるスコアのみランキングに登録され、外れるスコアは隔離されます。

非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]scoreDataList複数のスコアの情報。
[in]nexUniqueIdNEX ユニーク ID。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::Ranking2Client::GetCommonData ( ProtocolCallContext pContext,
Ranking2CommonData pCommonData,
qUnsignedInt32  optionFlags = 0,
PrincipalID  principalId = INVALID_PRINCIPALID,
UniqueId  nexUniqueId = INVALID_UNIQUEID 
)

ユーザー共通データを取得します。

ユーザー名、バイナリデータを格納したユーザー共通データを取得します。 ユーザー共通データを登録していないユーザーのデータを取得しようとした場合、それぞれの値が空の状態で返ります。

オプションフラグの指定により、Mii データも合わせて取得することができます。 Mii データは、該当ユーザーの 「じぶんの Mii」 のデータが取得されます。

非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[out]pCommonDataユーザー共通データ。
[in]optionFlagsオプションフラグ。Ranking2GetOptionFlags の値を指定します。
[in]principalIdプリンシパル ID。
[in]nexUniqueIdNEX ユニーク ID。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

参照
Ranking2GetOptionFlags
qBool nn::nex::Ranking2Client::PutCommonData ( ProtocolCallContext pContext,
const Ranking2CommonData commonData,
UniqueId  nexUniqueId = INVALID_UNIQUEID 
)

ユーザー共通データを登録します。

ユーザー名、バイナリデータを格納したユーザー共通データを登録します。

Mii データの登録は行いません。

ログインしているユーザーのデータのみを登録可能です。他のユーザーのデータを登録することはできません。

非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]commonDataユーザー共通データ。
[in]nexUniqueIdNEX ユニーク ID。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::Ranking2Client::DeleteCommonData ( ProtocolCallContext pContext,
UniqueId  nexUniqueId = INVALID_UNIQUEID 
)

ユーザー共通データを削除します。

ユーザー共通データを削除します。

Mii データの削除は行いません。

ログインしているユーザーのデータのみを削除可能です。他のユーザーのデータを削除することはできません。

非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]nexUniqueIdNEX ユニーク ID。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::Ranking2Client::GetRanking ( ProtocolCallContext pContext,
const Ranking2GetParam getParam,
Ranking2Info pRankingInfo 
)

ランキングを取得します。

指定した条件にしたがってランキングを取得します。条件の詳細は Ranking2GetParam を参照してください。

結果は Ranking2Info オブジェクトに格納されます。

条件に合致するデータが存在しない場合、 ランキングリストは空になりますが、その他の情報は取得することができます。

非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]getParamランキング取得条件の情報。
[out]pRankingInfoランキング情報。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::Ranking2Client::GetRanking ( ProtocolCallContext pContext,
const Ranking2GetByListParam getParam,
const qVector< PrincipalID > &  principalIdList,
Ranking2Info pRankingInfo 
)

プリンシパル ID リストを用いてランキングを取得します。

指定したプリンシパル ID リスト内の ID で登録されているデータだけを抽出したランキングを取得します。 その他の条件の詳細は Ranking2GetByListParam を参照してください。

結果は GetRanking と同様です。

非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]getParamランキング取得条件の情報。
[in]principalIdListプリンシパル ID リスト。
[out]pRankingInfoランキング情報。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::Ranking2Client::GetCategorySetting ( ProtocolCallContext pContext,
qUnsignedInt32  category,
Ranking2CategorySetting pCategorySetting 
)

カテゴリ設定を取得します。

指定したカテゴリに設定された値が取得できます。 設定されていないカテゴリを指定した場合、デフォルト値が取得できます。

引数
[in,out]pContext呼び出し情報。
[in]categoryカテゴリ。
[out]pCategorySettingカテゴリ設定。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

void nn::nex::ServiceClient::SetDefaultCredentials ( Credentials pCredentials)
inherited
引数
pCredentialsThe default Credentials for this service.
注釈
It is up to each ServiceClient to use this method to set the current Credentials in each of his protocols.
Credentials* nn::nex::ServiceClient::GetCredentials ( ) const
inherited

Bind() された Credentials オブジェクトを取得します。

戻り値
Bind() された Credentials オブジェクト。Bind() されていない場合、NULL を返します。