サービスアイテムを獲得すると同時にアカウント単位で利用する権利用バイナリデータを登録するためのパラメータを表すクラスです。 [詳解]
#include <RendezVous/Services/Jugem/ServiceItem/src/Common/ServiceItemAcquireServiceItemByAccountParam.h>
DDLCLASSServiceItemAcquireServiceItemByAccountParamを継承しています。
公開メンバ関数 | |
ServiceItemAcquireServiceItemByAccountParam () | |
コンストラクタです。 | |
virtual | ~ServiceItemAcquireServiceItemByAccountParam () |
デストラクタです。 | |
ServiceItemConstants::LimitationType | GetLimitationType () const |
権利種別を取得します。 [詳解] | |
qUnsignedInt32 | GetLimitationValue () const |
権利の値を取得します。 [詳解] | |
const String & | GetLogMessage () const |
ログメッセージを取得します。 [詳解] | |
qUnsignedInt16 | GetPeriodId () const |
有効期限 ID を取得します。 [詳解] | |
const String & | GetReferenceIdForAcquisition () const |
獲得したいサービスアイテムのリファレンス ID を取得します。 [詳解] | |
const String & | GetReferenceIdForRightBinary () const |
権利用バイナリデータを登録したいサービスアイテムのリファレンス ID を取得します。 [詳解] | |
void | GetRightBinary (qVector< qByte > &rightBinary_) const |
アカウント単位で利用する権利用バイナリデータを取得します。 [詳解] | |
qUnsignedInt32 | GetUniqueId () const |
ユニーク ID を取得します。 [詳解] | |
qByte | GetUseType () const |
権利用バイナリデータの利用タイプを取得します。 [詳解] | |
void | Reset () |
オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。 | |
void | SetLimitationType (ServiceItemConstants::LimitationType limitationType_) |
[必須パラメタ] 権利種別をセットします。 [詳解] | |
void | SetLimitationValue (qUnsignedInt32 limitationValue_) |
[必須パラメタ] 権利の値をセットします。 [詳解] | |
void | SetLogMessage (const String &logMessage_) |
[必須パラメタ] ログメッセージをセットします。 [詳解] | |
void | SetPeriodId (qUnsignedInt16 periodId_) |
有効期限 ID をセットします。 [詳解] | |
void | SetReferenceIdForAcquisition (const String &referenceIdForAcquisition_) |
[必須パラメタ] 獲得したいサービスアイテムのリファレンス ID をセットします。 [詳解] | |
void | SetReferenceIdForRightBinary (const String &referenceIdForRightBinary_) |
[必須パラメタ] 権利用バイナリデータを登録したいサービスアイテムのリファレンス ID をセットします。 [詳解] | |
void | SetRightBinary (const void *pRightBinary_, qUnsignedInt32 size_) |
アカウント単位で利用する権利用バイナリデータをセットします。 [詳解] | |
void | SetUniqueId (qUnsignedInt32 uniqueId_) |
[必須パラメタ] ユニーク ID をセットします。 [詳解] | |
void | SetUseType (qByte useType_) |
[必須パラメタ] 権利用バイナリデータの利用タイプをセットします。 [詳解] | |
void | Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const |
ServiceItemAcquireServiceItemByAccountParam オブジェクトの内容をトレースします。 [詳解] | |
サービスアイテムを獲得すると同時にアカウント単位で利用する権利用バイナリデータを登録するためのパラメータを表すクラスです。
権利用バイナリデータは、以下のすべてをキーにしてサーバで管理されます。 そのため、例えばリファレンス ID が同じであっても利用タイプを使い分けることで、 複数の権利用バイナリデータを登録することができます。
キーに該当する権利用バイナリが未登録の場合は追加、登録済の場合は更新されます。
登録した権利用バイナリデータは、 ServiceItemClient::GetServiceItemRight() で取得できます。
const String& nn::nex::ServiceItemAcquireServiceItemByAccountParam::GetReferenceIdForAcquisition | ( | ) | const |
獲得したいサービスアイテムのリファレンス ID を取得します。
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::SetReferenceIdForAcquisition | ( | const String & | referenceIdForAcquisition_ | ) |
[必須パラメタ] 獲得したいサービスアイテムのリファレンス ID をセットします。
[in] | referenceIdForAcquisition_ | 獲得したいサービスアイテムのリファレンス ID 。 |
const String& nn::nex::ServiceItemAcquireServiceItemByAccountParam::GetReferenceIdForRightBinary | ( | ) | const |
権利用バイナリデータを登録したいサービスアイテムのリファレンス ID を取得します。
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::SetReferenceIdForRightBinary | ( | const String & | referenceIdForRightBinary_ | ) |
[必須パラメタ] 権利用バイナリデータを登録したいサービスアイテムのリファレンス ID をセットします。
[in] | referenceIdForRightBinary_ | 権利用バイナリデータを登録したいサービスアイテムのリファレンス ID 。 |
qByte nn::nex::ServiceItemAcquireServiceItemByAccountParam::GetUseType | ( | ) | const |
権利用バイナリデータの利用タイプを取得します。
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::SetUseType | ( | qByte | useType_ | ) |
[必須パラメタ] 権利用バイナリデータの利用タイプをセットします。
アプリケーションでの権利用バイナリデータの用途に応じて 1-15 までの値をセットできます。
[in] | useType_ | 権利用バイナリデータの利用タイプ。 |
ServiceItemConstants::LimitationType nn::nex::ServiceItemAcquireServiceItemByAccountParam::GetLimitationType | ( | ) | const |
権利種別を取得します。
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::SetLimitationType | ( | ServiceItemConstants::LimitationType | limitationType_ | ) |
[必須パラメタ] 権利種別をセットします。
獲得したいサービスアイテムの権利種別をセットします。 現時点では、獲得できるサービスアイテムの種類として消費型サービス利用券のみをサポートしているため、 必ず ServiceItemConstants::LIMITATION_TYPE_CONSUMPTION をセットしてください。
[in] | limitationType_ | 獲得したいサービスアイテムの権利種別。 |
qUnsignedInt32 nn::nex::ServiceItemAcquireServiceItemByAccountParam::GetLimitationValue | ( | ) | const |
権利の値を取得します。
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::SetLimitationValue | ( | qUnsignedInt32 | limitationValue_ | ) |
[必須パラメタ] 権利の値をセットします。
獲得したいサービスアイテムの権利種別に応じた値をセットします。 権利種別が ServiceItemConstants::LIMITATION_TYPE_PERMANENT の場合はセットする必要はありません。 ServiceItemConstants::LIMITATION_TYPE_ADDITIONAL_TIME の場合は有効期間 (秒数) をセットします。 ServiceItemConstants::LIMITATION_TYPE_CONSUMPTION の場合は個数をセットします。
[in] | limitationValue_ | 獲得したいサービスアイテムの権利の値。 |
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::GetRightBinary | ( | qVector< qByte > & | rightBinary_ | ) | const |
アカウント単位で利用する権利用バイナリデータを取得します。
[out] | rightBinary_ | アカウント単位で利用する権利用バイナリデータ。 |
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::SetRightBinary | ( | const void * | pRightBinary_, |
qUnsignedInt32 | size_ | ||
) |
アカウント単位で利用する権利用バイナリデータをセットします。
アカウント単位で利用する、権利で保護すべきバイナリデータを指定します。 0 ~ ServiceItemConstants::RIGHT_BINARY_MAX_SIZE バイトまでセットできます。 本パラメータの指定は必須ではありません。セットしない場合の初期値は空です。
指定された権利用バイナリデータがそのままサーバに登録されます。 空の場合に、削除されたり登録がスキップされることはありません。
[in] | pRightBinary_ | アカウント単位で利用する権利用バイナリデータのポインタ。 NULL を指定すると空になります。 |
[in] | size_ | アカウント単位で利用する権利用バイナリデータのデータサイズ (0 ~ ServiceItemConstants::RIGHT_BINARY_MAX_SIZE) 。 |
const String& nn::nex::ServiceItemAcquireServiceItemByAccountParam::GetLogMessage | ( | ) | const |
ログメッセージを取得します。
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::SetLogMessage | ( | const String & | logMessage_ | ) |
[必須パラメタ] ログメッセージをセットします。
ユーザサポート向けの管理ツールに表示されるログメッセージをセットします。 最大で ServiceItemConstants::SUPPORT_LOG_MESSAGE_MAX_SIZE バイトまでセットできます。
[in] | logMessage_ | ログメッセージ。 |
qUnsignedInt32 nn::nex::ServiceItemAcquireServiceItemByAccountParam::GetUniqueId | ( | ) | const |
ユニーク ID を取得します。
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::SetUniqueId | ( | qUnsignedInt32 | uniqueId_ | ) |
[必須パラメタ] ユニーク ID をセットします。
NEX サーバーから接続する eShop サーバーを決定するためのパラメーターです。 通常はタイトルのユニーク ID を指定します。
[in] | uniqueId_ | ユニーク ID。 |
qUnsignedInt16 nn::nex::ServiceItemAcquireServiceItemByAccountParam::GetPeriodId | ( | ) | const |
有効期限 ID を取得します。
periodId は、消費型サービス利用券の有効期限を設定するための ID です。 pid ごとに有効期限を変えたい場合に使用します。
periodId を指定しない場合の初期値は 0 となり、 有効期限は、日本のタイムゾーンの 4 ヶ月後の月末となります。
periodId に紐づいた有効期限の設定値をサーバに登録する必要があるため、 利用する場合はサーバー担当者にご相談ください。
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::SetPeriodId | ( | qUnsignedInt16 | periodId_ | ) |
有効期限 ID をセットします。
periodId は、消費型サービス利用券の有効期限を設定するための ID です。 pid ごとに有効期限を変えたい場合に使用します。
periodId を指定しない場合の初期値は 0 となり、 有効期限は、日本のタイムゾーンの 4 ヶ月後の月末となります。
periodId に紐づいた有効期限の設定値をサーバに登録する必要があるため、 利用する場合はサーバー担当者にご相談ください。
[in] | periodId_ | 有効期限 ID。 |
void nn::nex::ServiceItemAcquireServiceItemByAccountParam::Trace | ( | qUnsignedInt64 | uiTraceFlags = TRACE_ALWAYS | ) | const |
ServiceItemAcquireServiceItemByAccountParam オブジェクトの内容をトレースします。
[in] | uiTraceFlags | TraceLog::SetFlag() の引数と同様です。 |