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

サービスアイテムを購入するためのパラメータを表すクラスです。 [詳解]

#include <RendezVous/Services/Jugem/ServiceItem/src/Common/ServiceItemPurchaseServiceItemParam.h>

DDLCLASSServiceItemPurchaseServiceItemParamを継承しています。

公開メンバ関数

 ServiceItemPurchaseServiceItemParam ()
 コンストラクタです。
 
virtual ~ServiceItemPurchaseServiceItemParam ()
 デストラクタです。
 
const StringGetCurrentBalanceRawValue () const
 アカウントの未フォーマットの残高を取得します。 [詳解]
 
const StringGetEcServiceToken () const
 EC サービストークンを取得します。 [詳解]
 
const StringGetItemCode () const
 アイテムコードを取得します。 [詳解]
 
const StringGetItemName () const
 アイテム名を取得します。 [詳解]
 
const StringGetLanguage () const
 言語を取得します。 [詳解]
 
qUnsignedInt16 GetPeriodId () const
 有効期限 ID を取得します。 [詳解]
 
const StringGetPriceId () const
 価格情報の識別 ID を取得します。 [詳解]
 
const StringGetReferenceId () const
 リファレンス ID を取得します。 [詳解]
 
qUnsignedInt32 GetUniqueId () const
 ユニーク ID を取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetCurrentBalanceRawValue (const String &balance_)
 [必須パラメタ] アカウントの未フォーマットの残高をセットします。 [詳解]
 
void SetEcServiceToken (const String &ecServiceToken_)
 EC サービストークンをセットします。 [詳解]
 
void SetItemCode (const String &itemCode_)
 [必須パラメタ] アイテムコードをセットします。 [詳解]
 
void SetItemName (const String &itemName_)
 [必須パラメタ] アイテム名をセットします。 [詳解]
 
void SetLanguage (const String &language_)
 [必須パラメタ] 言語をセットします。 [詳解]
 
void SetPeriodId (qUnsignedInt16 periodId_)
 有効期限 ID をセットします。 [詳解]
 
void SetPriceId (const String &priceId_)
 [必須パラメタ] 価格情報の識別 ID をセットします。 [詳解]
 
void SetReferenceId (const String &referenceId_)
 [必須パラメタ] リファレンス ID をセットします。 [詳解]
 
void SetUniqueId (qUnsignedInt32 uniqueId_)
 [必須パラメタ] ユニーク ID をセットします。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 ServiceItemPurchaseServiceItemParam オブジェクトの内容をトレースします。 [詳解]
 

詳解

サービスアイテムを購入するためのパラメータを表すクラスです。

関数詳解

const String& nn::nex::ServiceItemPurchaseServiceItemParam::GetItemCode ( ) const

アイテムコードを取得します。

戻り値
アイテムコード。
void nn::nex::ServiceItemPurchaseServiceItemParam::SetItemCode ( const String itemCode_)

[必須パラメタ] アイテムコードをセットします。

購入したいサービスアイテムのアイテムコードをセットします。

引数
[in]itemCode_購入したいサービスアイテムのアイテムコード。
const String& nn::nex::ServiceItemPurchaseServiceItemParam::GetPriceId ( ) const

価格情報の識別 ID を取得します。

戻り値
価格情報の識別 ID 。
void nn::nex::ServiceItemPurchaseServiceItemParam::SetPriceId ( const String priceId_)

[必須パラメタ] 価格情報の識別 ID をセットします。

ServiceItemClient::GetPrepurchaseInfo() で取得した、購入したいサービスアイテムの価格情報の識別 ID をセットします。

引数
[in]priceId_購入したいサービスアイテムの価格情報の識別 ID。
const String& nn::nex::ServiceItemPurchaseServiceItemParam::GetReferenceId ( ) const

リファレンス ID を取得します。

戻り値
リファレンス ID。
void nn::nex::ServiceItemPurchaseServiceItemParam::SetReferenceId ( const String referenceId_)

[必須パラメタ] リファレンス ID をセットします。

購入したいサービスアイテムのリファレンス ID をセットします。

引数
[in]referenceId_購入したいサービスアイテムのリファレンス ID。
const String& nn::nex::ServiceItemPurchaseServiceItemParam::GetCurrentBalanceRawValue ( ) const

アカウントの未フォーマットの残高を取得します。

戻り値
アカウントの未フォーマットの残高。
void nn::nex::ServiceItemPurchaseServiceItemParam::SetCurrentBalanceRawValue ( const String balance_)

[必須パラメタ] アカウントの未フォーマットの残高をセットします。

ServiceItemClient::GetBalance() もしくは ServiceItemClient::GetPrepurchaseInfo() で取得した、アカウントの未フォーマットの残高をセットします。 未フォーマットの残高は、残高を表す ServiceItemAmount オブジェクトの ServiceItemAmount::GetRawValue() で取得できます。

引数
[in]balance_アカウントの未フォーマットの残高。
const String& nn::nex::ServiceItemPurchaseServiceItemParam::GetItemName ( ) const

アイテム名を取得します。

戻り値
アイテム名。
void nn::nex::ServiceItemPurchaseServiceItemParam::SetItemName ( const String itemName_)

[必須パラメタ] アイテム名をセットします。

購入するサービスアイテムのアイテム名をセットします。購入履歴での表示用です。

引数
[in]itemName_購入するサービスアイテムのアイテム名。
const String& nn::nex::ServiceItemPurchaseServiceItemParam::GetEcServiceToken ( ) const

EC サービストークンを取得します。

戻り値
EC サービストークン。
void nn::nex::ServiceItemPurchaseServiceItemParam::SetEcServiceToken ( const String ecServiceToken_)

EC サービストークンをセットします。

NNAS から取得したNintendo eShop のサービストークン (Base64 フォーマット) をセットします。 ServiceItemClient::AcquireEcServiceTokenAndPurchaseServiceItem() を使用する場合はライブラリ内部で自動的に EC サービストークンを取得するため、 本関数でのセットは不要です。

引数
[in]ecServiceToken_EC サービストークン。
const String& nn::nex::ServiceItemPurchaseServiceItemParam::GetLanguage ( ) const

言語を取得します。

戻り値
言語。
void nn::nex::ServiceItemPurchaseServiceItemParam::SetLanguage ( const String language_)

[必須パラメタ] 言語をセットします。

言語をセットします。通貨表記のフォーマットを決定するために使用します。 ISO 639 で規定されている 2 文字の言語コードを使用します。

nn::cfg::CTR::GetLanguageCodeA2() 関数で取得した文字列を指定してください。

引数
[in]language_言語。
qUnsignedInt32 nn::nex::ServiceItemPurchaseServiceItemParam::GetUniqueId ( ) const

ユニーク ID を取得します。

戻り値
ユニーク ID。
void nn::nex::ServiceItemPurchaseServiceItemParam::SetUniqueId ( qUnsignedInt32  uniqueId_)

[必須パラメタ] ユニーク ID をセットします。

NEX サーバーから接続する eShop サーバーを決定するためのパラメーターです。 通常はタイトルのユニーク ID を指定します。

引数
[in]uniqueId_ユニーク ID。
qUnsignedInt16 nn::nex::ServiceItemPurchaseServiceItemParam::GetPeriodId ( ) const

有効期限 ID を取得します。

periodId は、消費型サービス利用券の有効期限を設定するための ID です。 pid ごとに有効期限を変えたい場合に使用します。 periodId に紐づいた有効期限の設定値をサーバに登録する必要があるため、 利用する場合はサーバー担当者にご相談ください。

戻り値
有効期限 ID。
void nn::nex::ServiceItemPurchaseServiceItemParam::SetPeriodId ( qUnsignedInt16  periodId_)

有効期限 ID をセットします。

periodId は、消費型サービス利用券の有効期限を設定するための ID です。 pid ごとに有効期限を変えたい場合に使用します。 periodId に紐づいた有効期限の設定値をサーバに登録する必要があるため、 利用する場合はサーバー担当者にご相談ください。

引数
[in]periodId_有効期限 ID。
void nn::nex::ServiceItemPurchaseServiceItemParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

ServiceItemPurchaseServiceItemParam オブジェクトの内容をトレースします。

引数
[in]uiTraceFlagsTraceLog::SetFlag() の引数と同様です。