Ranking2 機能を利用するためのクラス。 [詳解]
#include <RendezVous/Services/Jugem/Ranking2/src/Client/Ranking2Client.h>
Ranking2 機能を利用するためのクラス。
nn::nex::Ranking2Client::Ranking2Client | ( | ) |
コンストラクタです。
コンストラクタです。
|
virtual |
デストラクタです。
デストラクタです。
qBool nn::nex::Ranking2Client::PutScore | ( | ProtocolCallContext * | pContext, |
const Ranking2ScoreData & | scoreData, | ||
UniqueId | nexUniqueId = INVALID_UNIQUEID |
||
) |
スコアを登録します。
1つのスコアを1つのカテゴリに登録します。 ログインしているユーザーのスコアのみを登録可能です。他のユーザーのスコアを登録することはできません。 カテゴリ設定で指定された正常範囲を外れたスコアが渡された場合は、ランキングには現れない場所に不正スコアとして隔離して保存されます。
非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。
[in,out] | pContext | 呼び出し情報。 |
[in] | scoreData | スコアの情報。 |
[in] | nexUniqueId | NEX ユニーク 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] | nexUniqueId | NEX ユニーク 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] | nexUniqueId | NEX ユニーク ID。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::Ranking2Client::PutCommonData | ( | ProtocolCallContext * | pContext, |
const Ranking2CommonData & | commonData, | ||
UniqueId | nexUniqueId = INVALID_UNIQUEID |
||
) |
ユーザー共通データを登録します。
ユーザー名、バイナリデータを格納したユーザー共通データを登録します。
Mii データの登録は行いません。
ログインしているユーザーのデータのみを登録可能です。他のユーザーのデータを登録することはできません。
非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。
[in,out] | pContext | 呼び出し情報。 |
[in] | commonData | ユーザー共通データ。 |
[in] | nexUniqueId | NEX ユニーク 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] | nexUniqueId | NEX ユニーク 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 により停止します。
qBool nn::nex::Ranking2Client::GetRankingChart | ( | ProtocolCallContext * | pContext, |
const Ranking2ChartInfoInput & | info, | ||
Ranking2ChartInfo * | pChart | ||
) |
ランキングチャートデータを取得します。
info で指定されたランキングチャートデータを取得します。
非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。
初回更新前や設定ミスがあった場合はランキングチャートデータが生成されません。 そのような生成されていないランキングチャートデータを取得しようとした場合は pChart->IsValid() が false を返すオブジェクトが返ります。
[in,out] | pContext | 呼び出し情報。 |
[in] | info | 取得するランキングチャートデータを指定 |
[out] | pChart | ランキングチャートデータ |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::Ranking2Client::GetRankingChart | ( | ProtocolCallContext * | pContext, |
const qVector< Ranking2ChartInfoInput > & | infoArray, | ||
qVector< Ranking2ChartInfo > * | pChartArray | ||
) |
ランキングチャートデータを複数取得します。
infoArray で指定されたランキングチャートデータを複数取得します。 一度に最大 Ranking2Constants::MAX_CHART_GET_LENGTH 設定可能です。
非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。
初回更新前や設定ミスがあった場合はランキングチャートデータが生成されません。そのような生成されていないチャートデータは結果に含まれません。
[in,out] | pContext | 呼び出し情報。 |
[in] | infoArray | 取得するランキングチャートデータを指定した qVector 配列 |
[out] | pChartArray | ランキングチャートデータの qVector 配列 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::Ranking2Client::GetEstimateScoreRank | ( | ProtocolCallContext * | pContext, |
const Ranking2EstimateScoreRankInput & | input, | ||
Ranking2EstimateScoreRankOutput * | pOutput | ||
) |
スコアから順位を推定します。最低順位を下回るスコアでも推定値で順位を取得できます。
最低順位を下回るスコアは、サンプリングされたデータに基づいて推測して算出します。
データが存在しない場合は、pOutput->rank や pOutput->length が 0 となります。
非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。
[in,out] | pContext | 呼び出し情報。 |
[in] | input | スコアと、カテゴリ等の設定 |
[out] | pOutput | 推定された順位結果 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
|
inherited |
pCredentials | The default Credentials for this service. |
|
virtualinherited |
サービスを利用するための証明書を登録します。
サービスを利用するための証明書をセットします。 機能を利用する前にセットする必要があります。NgsFacade::Login() の非同期処理に成功後、 NgsFacade::GetCredentials() で取得した証明書を引数に指定してください。 Bind() で証明書をセットした後もう一度 Bind() を呼び出すと証明書を差し替える事ができます。
[in] | pCredentials | サービスにアクセスするための証明書。 |
true 成功。pCredentials が NULL でない場合は必ず成功します。
false pCredentials に NULL が指定された。
|
virtualinherited |
|
inherited |
Bind() された Credentials オブジェクトを取得します。