サービスアイテム機能を利用するためのクラスです。 [詳解]
#include <RendezVous/Services/Jugem/ServiceItem/src/Client/ServiceItemClient.h>
公開メンバ関数 | |
ServiceItemClient () | |
コンストラクタです。 [詳解] | |
virtual | ~ServiceItemClient () |
デストラクタです。 [詳解] | |
qBool | AcquireEcServiceTokenAndPurchaseServiceItem (ProtocolCallContext *pContext, const ServiceItemPurchaseServiceItemParam &request, ServiceItemPurchaseServiceItemResponse *response) |
EC サービストークンを取得し、サービスアイテムを購入します。 [詳解] | |
qBool | AcquireEcServiceTokenAndRedeemServiceItem (ProtocolCallContext *pContext, const ServiceItemRedeemServiceItemParam &request, ServiceItemRedeemServiceItemResponse *response) |
EC サービストークンを取得し、サービスアイテムを引き換えます。 [詳解] | |
virtual qBool | AcquireServiceItemByAccount (ProtocolCallContext *pContext, const ServiceItemAcquireServiceItemByAccountParam &request, ServiceItemAcquireServiceItemResponse *response) |
サービスアイテムを獲得すると同時にアカウント単位で利用する権利用バイナリデータを登録します。 [詳解] | |
virtual qBool | Bind (Credentials *pCredentials) |
サービスを利用するための証明書を登録します。 [詳解] | |
qBool | CancelAutoBilling (ProtocolCallContext *pContext, const ServiceItemCancelAutoBillingParam &request, ServiceItemCancelAutoBillingResponse *response) |
継続課金を解除します。 [詳解] | |
qBool | GetAutoBillingContract (ProtocolCallContext *pContext, const ServiceItemGetAutoBillingContractParam &request, ServiceItemGetAutoBillingContractResponse *response) |
現在契約中の継続課金アイテムを取得します。 [詳解] | |
qBool | GetBalance (ProtocolCallContext *pContext, const ServiceItemGetBalanceParam &request, ServiceItemGetBalanceResponse *response) |
アカウントの残高情報を取得します。 [詳解] | |
qBool | GetLawMessage (ProtocolCallContext *pContext, const ServiceItemGetLawMessageParam &request, ServiceItemGetLawMessageResponse *response) |
法令に基づく表示のメッセージを取得します。 [詳解] | |
qBool | GetPrepurchaseInfo (ProtocolCallContext *pContext, const ServiceItemGetPrepurchaseInfoParam &request, ServiceItemGetPrepurchaseInfoResponse *response) |
購入前情報を取得します。 [詳解] | |
qBool | GetPurchaseHistory (ProtocolCallContext *pContext, const ServiceItemGetPurchaseHistoryParam &request, ServiceItemGetPurchaseHistoryResponse *response) |
購入履歴を取得します。 [詳解] | |
qBool | GetServiceItemRight (ProtocolCallContext *pContext, const ServiceItemGetServiceItemRightParam &request, ServiceItemGetServiceItemRightResponse *response) |
権利情報を取得します。 [詳解] | |
qBool | GetServiceItemRightStatement (ProtocolCallContext *pContext, const ServiceItemGetServiceItemRightParam &request, ServiceItemGetServiceItemRightResponse *response) |
権利用バイナリを除いた権利情報を取得します。 [詳解] | |
virtual qBool | GetSupportId (ProtocolCallContext *pContext, String *supportId, const ServiceItemGetSupportIdParam ¶m) |
ユーザーを一意に識別できるサポート ID を取得します。 [詳解] | |
qBool | ListAutoBillingServiceItem (ProtocolCallContext *pContext, const ServiceItemListAutoBillingServiceItemParam &request, ServiceItemListAutoBillingServiceItemResponse *response) |
継続課金アイテム一覧を取得します。 [詳解] | |
qBool | ListRedemptionServiceItem (ProtocolCallContext *pContext, const ServiceItemListRedemptionServiceItemParam &request, ServiceItemListRedemptionServiceItemResponse *response) |
引換番号で引換可能なサービスアイテムの一覧を取得します。 [詳解] | |
qBool | ListServiceItem (ProtocolCallContext *pContext, const ServiceItemListServiceItemParam &request, ServiceItemListServiceItemResponse *response) |
販売しているサービスアイテムの一覧を取得します。 [詳解] | |
virtual qBool | PostRightBinaryByAccount (ProtocolCallContext *pContext, const ServiceItemPostRightBinaryByAccountParam &request, ServiceItemPostRightBinaryResponse *response) |
アカウント単位で利用する権利用バイナリデータを登録します。 [詳解] | |
qBool | PurchaseServiceItem (ProtocolCallContext *pContext, const ServiceItemPurchaseServiceItemParam &request, ServiceItemPurchaseServiceItemResponse *response) |
サービスアイテムを購入します。 [詳解] | |
qBool | RedeemServiceItem (ProtocolCallContext *pContext, const ServiceItemRedeemServiceItemParam &request, ServiceItemRedeemServiceItemResponse *response) |
サービスアイテムを引き換えます。 [詳解] | |
void | SetDefaultCredentials (Credentials *pCredentials) |
virtual qBool | Unbind () |
証明書の登録を解除します。 [詳解] | |
qBool | UseServiceItemByAccount (ProtocolCallContext *pContext, const ServiceItemUseServiceItemByAccountParam &request, ServiceItemUseServiceItemResponse *response) |
アカウント単位で消費型サービス利用券を消費すると同時に権利用バイナリデータを登録します。 [詳解] | |
サービスアイテム機能を利用するためのクラスです。
典型的な API の発行順序を以下に示します。
(1) NGS にログインします。
(2) GetServiceItemRight() で最新の権利情報を取得します。
(3) サービスアイテムを購入するシーンの場合は以下を行います。
(3-1) ListServiceItem() で販売しているサービスアイテムの一覧を取得し、購入画面を表示します。
(3-2) GetPrepurchaseInfo() で購入前情報を取得し、購入の最終確認画面を表示します。
(3-3) AcquireEcServiceTokenAndPurchaseServiceItem() で購入します。
(3-4) GetServiceItemRight() で最新の権利情報を取得し直します。
(4) 消費型サービス利用券を消費するシーンの場合は以下を行います。
(4-1) UseServiceItemByAccount() で消費型サービス利用券を消費します。
この時、ユーザサポート向けの管理ツールに表示されるログメッセージをセットします。
また、保護すべきデータを権利用バイナリデータとしてセットできます。
セットした権利用バイナリデータは GetServiceItemRight() で権利情報として取得できます。
(4-2) 消費型サービス利用券を消費した対価となるアプリケーションの処理を行います。
(4-3) 必要に応じて PostRightBinaryByAccount() でユーザサポート向けの管理ツールに表示されるログメッセージと権利用バイナリをセットします。
セットした権利用バイナリデータは GetServiceItemRight() で権利情報として取得できます。
(5) 特別に無料でサービスアイテムを獲得したい場合は AcquireServiceItemByAccount() を実行します。
この時、ユーザサポート向けの管理ツールに表示されるログメッセージをセットします。
また、保護すべきデータを権利用バイナリデータとしてセットできます。
セットした権利用バイナリデータは GetServiceItemRight() で権利情報として取得できます。
(6) 権利情報の詳細画面を表示する場合は毎回 GetServiceItemRightStatement() で最新の権利情報を取得します。
nn::nex::ServiceItemClient::ServiceItemClient | ( | ) |
コンストラクタです。
コンストラクタです。
|
virtual |
デストラクタです。
デストラクタです。
|
virtual |
サービスアイテムを購入します。
本関数を使用する場合はアプリケーションで事前に EC サービストークンを取得する必要があります。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
nn::nex::ServiceItemClientInterfaceを実装しています。
qBool nn::nex::ServiceItemClient::ListServiceItem | ( | ProtocolCallContext * | pContext, |
const ServiceItemListServiceItemParam & | request, | ||
ServiceItemListServiceItemResponse * | response | ||
) |
販売しているサービスアイテムの一覧を取得します。
サービスイン後の変更を考慮し、サーバから受け取ったカタログの順番・個数をそのままアプリケーション側で表示してください。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::GetBalance | ( | ProtocolCallContext * | pContext, |
const ServiceItemGetBalanceParam & | request, | ||
ServiceItemGetBalanceResponse * | response | ||
) |
アカウントの残高情報を取得します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::GetPrepurchaseInfo | ( | ProtocolCallContext * | pContext, |
const ServiceItemGetPrepurchaseInfoParam & | request, | ||
ServiceItemGetPrepurchaseInfoResponse * | response | ||
) |
購入前情報を取得します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::GetServiceItemRight | ( | ProtocolCallContext * | pContext, |
const ServiceItemGetServiceItemRightParam & | request, | ||
ServiceItemGetServiceItemRightResponse * | response | ||
) |
権利情報を取得します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::GetServiceItemRightStatement | ( | ProtocolCallContext * | pContext, |
const ServiceItemGetServiceItemRightParam & | request, | ||
ServiceItemGetServiceItemRightResponse * | response | ||
) |
権利用バイナリを除いた権利情報を取得します。
本関数は権利用バイナリを返却しない以外は GetServiceItemRight() と同様の結果を返却します。 権利用バイナリが含まれる qVector<ServiceItemRightBinary> のサイズは 0 となります。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::GetPurchaseHistory | ( | ProtocolCallContext * | pContext, |
const ServiceItemGetPurchaseHistoryParam & | request, | ||
ServiceItemGetPurchaseHistoryResponse * | response | ||
) |
購入履歴を取得します。
レスポンスは最新の購入履歴から昇順でソートされた状態で返ってきます。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::GetLawMessage | ( | ProtocolCallContext * | pContext, |
const ServiceItemGetLawMessageParam & | request, | ||
ServiceItemGetLawMessageResponse * | response | ||
) |
法令に基づく表示のメッセージを取得します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::ListAutoBillingServiceItem | ( | ProtocolCallContext * | pContext, |
const ServiceItemListAutoBillingServiceItemParam & | request, | ||
ServiceItemListAutoBillingServiceItemResponse * | response | ||
) |
継続課金アイテム一覧を取得します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::GetAutoBillingContract | ( | ProtocolCallContext * | pContext, |
const ServiceItemGetAutoBillingContractParam & | request, | ||
ServiceItemGetAutoBillingContractResponse * | response | ||
) |
現在契約中の継続課金アイテムを取得します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::CancelAutoBilling | ( | ProtocolCallContext * | pContext, |
const ServiceItemCancelAutoBillingParam & | request, | ||
ServiceItemCancelAutoBillingResponse * | response | ||
) |
継続課金を解除します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::ListRedemptionServiceItem | ( | ProtocolCallContext * | pContext, |
const ServiceItemListRedemptionServiceItemParam & | request, | ||
ServiceItemListRedemptionServiceItemResponse * | response | ||
) |
引換番号で引換可能なサービスアイテムの一覧を取得します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
|
virtual |
サービスアイテムを引き換えます。
本関数を使用する場合はアプリケーションで事前に EC サービストークンを取得する必要があります。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
nn::nex::ServiceItemClientInterfaceを実装しています。
qBool nn::nex::ServiceItemClient::AcquireEcServiceTokenAndPurchaseServiceItem | ( | ProtocolCallContext * | pContext, |
const ServiceItemPurchaseServiceItemParam & | request, | ||
ServiceItemPurchaseServiceItemResponse * | response | ||
) |
EC サービストークンを取得し、サービスアイテムを購入します。
本関数を使用する場合はアプリケーションで事前に EC サービストークンを取得する必要はありません。 EC サービストークンを並列して取得することができないため、本関数ではレスポンスを受けとるまで並列して実行することはできません。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::AcquireEcServiceTokenAndRedeemServiceItem | ( | ProtocolCallContext * | pContext, |
const ServiceItemRedeemServiceItemParam & | request, | ||
ServiceItemRedeemServiceItemResponse * | response | ||
) |
EC サービストークンを取得し、サービスアイテムを引き換えます。
本関数を使用する場合はアプリケーションで事前に EC サービストークンを取得する必要はありません。 EC サービストークンを並列して取得することができないため、本関数ではレスポンスを受けとるまで並列して実行することはできません。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
qBool nn::nex::ServiceItemClient::UseServiceItemByAccount | ( | ProtocolCallContext * | pContext, |
const ServiceItemUseServiceItemByAccountParam & | request, | ||
ServiceItemUseServiceItemResponse * | response | ||
) |
アカウント単位で消費型サービス利用券を消費すると同時に権利用バイナリデータを登録します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true 非同期処理の開始に成功。
false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。
|
virtualinherited |
アカウント単位で利用する権利用バイナリデータを登録します。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true RMC 呼び出しの初期化に成功。
false 失敗。
|
virtualinherited |
サービスアイテムを獲得すると同時にアカウント単位で利用する権利用バイナリデータを登録します。
現時点では、獲得できるサービスアイテムの種類として消費型サービス利用券のみをサポートしています。 本関数で取得できるサービスアイテムの最大数は9999です。これ以上の数のアイテムの購入が必要になる場合はアイテム自体を別にする等の対応が必要になります。
[in,out] | pContext | 呼び出し情報。 |
[in] | request | リクエストパラメータ。 |
[out] | response | レスポンス。 |
true RMC 呼び出しの初期化に成功。
false 失敗。
|
virtualinherited |
ユーザーを一意に識別できるサポート ID を取得します。
[in,out] | pContext | 呼び出し情報。 |
[out] | supportId | サポート ID を受け取る文字列オブジェクト。 |
[in] | param | 追加のユーザー情報。 |
true RMC 呼び出しの初期化に成功。
false 失敗。
|
inherited |
pCredentials | The default Credentials for this service. |
|
virtualinherited |
サービスを利用するための証明書を登録します。
サービスを利用するための証明書をセットします。 機能を利用する前にセットする必要があります。NgsFacade::Login() の非同期処理に成功後、 NgsFacade::GetCredentials() で取得した証明書を引数に指定してください。 Bind() で証明書をセットした後もう一度 Bind() を呼び出すと証明書を差し替える事ができます。
[in] | pCredentials | サービスにアクセスするための証明書。 |
true 成功。pCredentials が NULL でない場合は必ず成功します。
false pCredentials に NULL が指定された。