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

アカウント単位で利用する権利用バイナリデータを登録するためのパラメータを表すクラスです。 [詳解]

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

DDLCLASSServiceItemPostRightBinaryByAccountParamを継承しています。

公開メンバ関数

 ServiceItemPostRightBinaryByAccountParam ()
 コンストラクタです。
 
virtual ~ServiceItemPostRightBinaryByAccountParam ()
 デストラクタです。
 
const StringGetLogMessage () const
 ログメッセージを取得します。 [詳解]
 
const StringGetReferenceId () const
 リファレンス ID を取得します。 [詳解]
 
void GetRightBinary (qVector< qByte > &rightBinary_) const
 アカウント単位で利用する権利用バイナリデータを取得します。 [詳解]
 
qUnsignedInt32 GetUniqueId () const
 ユニーク ID を取得します。 [詳解]
 
qByte GetUseType () const
 権利用バイナリデータの利用タイプを取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetLogMessage (const String &logMessage_)
 [必須パラメタ] ログメッセージをセットします。 [詳解]
 
void SetReferenceId (const String &referenceId_)
 [必須パラメタ] リファレンス ID をセットします。 [詳解]
 
void SetRightBinary (const void *pRightBinary, qUnsignedInt32 size)
 アカウント単位で利用する権利用バイナリデータをセットします。 [詳解]
 
void SetUniqueId (qUnsignedInt32 uniqueId_)
 [必須パラメタ] ユニーク ID をセットします。 [詳解]
 
void SetUseType (qByte useType_)
 [必須パラメタ] 権利用バイナリデータの利用タイプをセットします。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 ServiceItemPostRightBinaryByAccountParam オブジェクトの内容をトレースします。 [詳解]
 

詳解

アカウント単位で利用する権利用バイナリデータを登録するためのパラメータを表すクラスです。

権利用バイナリデータは、以下のすべてをキーにしてサーバで管理されます。 そのため、例えばリファレンス ID が同じであっても利用タイプを使い分けることで、 複数の権利用バイナリデータを登録することができます。

  • プリンシパル ID
  • リファレンス ID
  • 利用タイプ

キーに該当する権利用バイナリが未登録の場合は追加、登録済の場合は更新されます。

登録した権利用バイナリデータは、 ServiceItemClient::GetServiceItemRight() で取得できます。

関数詳解

const String& nn::nex::ServiceItemPostRightBinaryByAccountParam::GetReferenceId ( ) const

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

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

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

消費型サービス利用券のリファレンス ID をセットします。

引数
[in]referenceId_消費したい消費型サービス利用券のリファレンス ID 。
qByte nn::nex::ServiceItemPostRightBinaryByAccountParam::GetUseType ( ) const

権利用バイナリデータの利用タイプを取得します。

戻り値
権利用バイナリデータの利用タイプ。
void nn::nex::ServiceItemPostRightBinaryByAccountParam::SetUseType ( qByte  useType_)

[必須パラメタ] 権利用バイナリデータの利用タイプをセットします。

アプリケーションでの権利用バイナリデータの用途に応じて 1-15 までの値をセットできます。

引数
[in]useType_権利用バイナリデータの利用タイプ。
void nn::nex::ServiceItemPostRightBinaryByAccountParam::GetRightBinary ( qVector< qByte > &  rightBinary_) const

アカウント単位で利用する権利用バイナリデータを取得します。

引数
[out]rightBinary_アカウント単位で利用する権利用バイナリデータ。
void nn::nex::ServiceItemPostRightBinaryByAccountParam::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::ServiceItemPostRightBinaryByAccountParam::GetLogMessage ( ) const

ログメッセージを取得します。

戻り値
ログメッセージ。
void nn::nex::ServiceItemPostRightBinaryByAccountParam::SetLogMessage ( const String logMessage_)

[必須パラメタ] ログメッセージをセットします。

ユーザサポート向けの管理ツールに表示されるログメッセージをセットします。 最大で ServiceItemConstants::SUPPORT_LOG_MESSAGE_MAX_SIZE バイトまでセットできます。

引数
[in]logMessage_ログメッセージ。
qUnsignedInt32 nn::nex::ServiceItemPostRightBinaryByAccountParam::GetUniqueId ( ) const

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

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

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

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

引数
[in]uniqueId_ユニーク ID。
void nn::nex::ServiceItemPostRightBinaryByAccountParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

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

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