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

データのアップロードに関するパラメータを表すクラスです。 [詳解]

#include <RendezVous/Services/Jugem/DataStore/src/Common/DataStorePreparePostParam.h>

DDLCLASSDataStorePreparePostParamを継承しています。

公開メンバ関数

 DataStorePreparePostParam ()
 コンストラクタです。
 
virtual ~DataStorePreparePostParam ()
 デストラクタです。
 
qBool AddRatingSetting (qInt8 slot, const DataStoreRatingInitParam &ratingInitParam)
 評価スロットを一つ追加します。 [詳解]
 
void ClearRatingSetting ()
 評価スロットを未指定にします。
 
const DataStorePermissionGetAccessPermission () const
 参照権限を取得します。 [詳解]
 
qUnsignedInt32 GetDataFlag () const
 設定フラグを取得します。 [詳解]
 
qUnsignedInt16 GetDataType () const
 データタイプを取得します。 [詳解]
 
const DataStorePermissionGetDeletePermission () const
 更新権限を取得します。推奨されません。 [詳解]
 
qVector< qByteGetMetaBinary () const
 メタ情報内バイナリデータを取得します。 [詳解]
 
void GetMetaBinary (qVector< qByte > &metaBinary_) const
 メタ情報内バイナリデータを取得します。 [詳解]
 
String GetName () const
 タイトルを取得します。 [詳解]
 
qUnsignedInt16 GetPeriod () const
 有効日数を取得します。 [詳解]
 
const DataStorePersistenceInitParamGetPersistenceInitParam () const
 永続化情報を取得します。 [詳解]
 
void GetRatingSetting (qMap< qInt8, DataStoreRatingInitParam > &ratingInitParam) const
 評価スロットの初期化設定を取得します。 [詳解]
 
qUnsignedInt32 GetSize () const
 サイズを取得します。 [詳解]
 
const qVector< String > & GetTags () const
 タグを取得します。 [詳解]
 
const DataStorePermissionGetUpdatePermission () const
 更新権限を取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetAccessPermission (const DataStorePermission &permission_)
 参照権限をセットします。 [詳解]
 
void SetDataFlag (qUnsignedInt32 flag_)
 設定フラグをセットします。 [詳解]
 
void SetDataType (const qUnsignedInt16 dataType_)
 データタイプをセットします。 [詳解]
 
void SetDeletePermission (const DataStorePermission &delPermission_)
 更新権限をセットします。推奨されません。 [詳解]
 
void SetMetaBinary (const void *p, size_t size_)
 メタ情報内バイナリデータをセットします。 [詳解]
 
void SetName (const String &name_)
 タイトルをセットします [詳解]
 
void SetPeriod (qUnsignedInt16 period_)
 有効日数をセットします。 [詳解]
 
void SetPersistenceInitParam (const DataStorePersistenceInitParam &persistenceInitParam_)
 永続化情報をセットします。 [詳解]
 
void SetRatingSetting (const qMap< qInt8, DataStoreRatingInitParam > &ratingInitParam)
 評価スロットの初期化設定を行います [詳解]
 
void SetSize (qUnsignedInt32 size_)
 サイズをセットします [詳解]
 
void SetTags (const qVector< String > &tags_)
 タグをセットします [詳解]
 
void SetUpdatePermission (const DataStorePermission &updatePermission)
 更新権限をセットします。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 DataStorePreparePostParamオブジェクトの内容をトレースします。 [詳解]
 

詳解

データのアップロードに関するパラメータを表すクラスです。

このクラスは、 DataStorePostParam クラスと同一です。

関数詳解

void nn::nex::DataStorePreparePostParam::SetSize ( qUnsignedInt32  size_)

サイズをセットします

アップロードするデータのサイズを指定します。本パラメータは必ず指定する必要があります。 実際にアップロードするデータのサイズと一致している必要があります。 指定できる最大サイズは 10485760 バイトです。 メタ情報のみアップロードす場合は 0 を指定します。

引数
[in]size_アップロードするデータのサイズ。
qUnsignedInt32 nn::nex::DataStorePreparePostParam::GetSize ( ) const

サイズを取得します。

戻り値
サイズ。
void nn::nex::DataStorePreparePostParam::SetName ( const String name_)

タイトルをセットします

アップロードするデータにメタ情報として付加するタイトル(要約情報)を指定します。 Unicodeの任意の文字列(UTF-8の文字数換算で最大64文字)を指定することができます。本パラメータの指定は必須ではありません。デフォルトは空文字列です。

引数
[in]name_アップロードするデータにメタ情報として付加するタイトル(要約情報)。
String nn::nex::DataStorePreparePostParam::GetName ( ) const

タイトルを取得します。

戻り値
タイトル。
void nn::nex::DataStorePreparePostParam::SetDataType ( const qUnsignedInt16  dataType_)

データタイプをセットします。

アップロードするデータにメタ情報として付加するデータタイプを指定します。 ここでセットした値は DataStoreClient::SearchObject()DataStoreClient::SearchObjectLight() から検索できます。 デフォルトは0です。DataStoreConstants::INVALID_DATA_TYPE は使用できません。

引数
[in]dataType_アップロードするデータにメタ情報として付加するデータタイプ。
qUnsignedInt16 nn::nex::DataStorePreparePostParam::GetDataType ( ) const

データタイプを取得します。

戻り値
データタイプ。
void nn::nex::DataStorePreparePostParam::SetAccessPermission ( const DataStorePermission permission_)

参照権限をセットします。

アップロードするデータを検索、参照できる範囲を表す権限を指定します。 デフォルトは DataStorePermission(DataStoreConstants::PERMISSION_PRIVATE) です。

引数
[in]permission_アップロードするデータを検索、参照できる範囲を表す権限。
const DataStorePermission& nn::nex::DataStorePreparePostParam::GetAccessPermission ( ) const

参照権限を取得します。

戻り値
参照権限。
void nn::nex::DataStorePreparePostParam::SetDeletePermission ( const DataStorePermission delPermission_)

更新権限をセットします。推奨されません。

これは互換性のために残されている古い関数です。 DataStorePostParam::SetUpdatePermission() を使用して下さい。 新しい更新権限を指定します。本パラメータの指定は必須ではありません。デフォルトは DataStorePermission(DataStoreConstants::PERMISSION_PRIVATE) です。

引数
[in]delPermission_新しい更新権限。
const DataStorePermission& nn::nex::DataStorePreparePostParam::GetDeletePermission ( ) const

更新権限を取得します。推奨されません。

これは互換性のために残されている古い関数です。 DataStorePostParam::GetUpdatePermission() を使用して下さい。

戻り値
更新権限。
void nn::nex::DataStorePreparePostParam::SetUpdatePermission ( const DataStorePermission updatePermission)

更新権限をセットします。

新しい更新権限を指定します。本パラメータの指定は必須ではありません。デフォルトは DataStorePermission(DataStoreConstants::PERMISSION_PRIVATE) です。

引数
[in]updatePermission新しい更新権限。
const DataStorePermission& nn::nex::DataStorePreparePostParam::GetUpdatePermission ( ) const

更新権限を取得します。

戻り値
更新権限。
void nn::nex::DataStorePreparePostParam::SetDataFlag ( qUnsignedInt32  flag_)

設定フラグをセットします。

アップロードについての設定フラグを指定します。 DataStoreConstants::DataFlag に対してビット単位の論理和を用いて複数指定することができます。 デフォルトは DataStoreConstants::DATA_FLAG_NONE です。

引数
[in]flag_アップロードについての設定のビットフラグ。 DataStoreConstants::DataFlag に対するビット単位の論理和です。
qUnsignedInt32 nn::nex::DataStorePreparePostParam::GetDataFlag ( ) const

設定フラグを取得します。

戻り値
アップロードについての設定のビットフラグ。 DataStoreConstants::DataFlag に対するビット単位の論理和です。
void nn::nex::DataStorePreparePostParam::SetPeriod ( qUnsignedInt16  period_)

有効日数をセットします。

アップロードするデータを参照できる期間を日数で指定します。 SetFlag() の引数に DataStoreConstants::DATA_FLAG_PRIODFROMLASTREFERED を指定した場合は最後に DataStoreClient::GetObject 関数により参照された日からカウントされます。 DataStoreConstants::DATA_FLAG_PRIODFROMLASTREFERED を指定しなかった場合はアップロードした時点からカウントされます。 UpdateObjectを使用してデータを更新した場合、その時点から再カウントされます。 デフォルトは DataStoreConstants::DEFAULT_PERIOD です。 指定できる最大有効日数は365日です。それ以上の値を指定した場合の結果は、 QERROR(DataStore, InvalidArgument) になります。

引数
[in]period_アップロードするデータを参照できる期間(日数)。
qUnsignedInt16 nn::nex::DataStorePreparePostParam::GetPeriod ( ) const

有効日数を取得します。

戻り値
有効日数。
void nn::nex::DataStorePreparePostParam::SetTags ( const qVector< String > &  tags_)

タグをセットします

アップロードするデータにメタ情報として付加するタグを指定します。最大 DataStoreConstants::NUM_TAG_SLOT 個のタグを指定できます。 タグとして指定できる文字と文字数についてはプログラミングマニュアルを参照してください。 本パラメータの指定は必須ではありません。デフォルトは空です。

引数
[in]tags_アップロードするデータにメタ情報として付加するタグ。
const qVector<String>& nn::nex::DataStorePreparePostParam::GetTags ( ) const

タグを取得します。

戻り値
タグ。
void nn::nex::DataStorePreparePostParam::SetRatingSetting ( const qMap< qInt8, DataStoreRatingInitParam > &  ratingInitParam)

評価スロットの初期化設定を行います

本パラメータの指定は必須ではありません。デフォルトは未指定ですが、評価機能を利用する場合は 必ず初期化が必要になります。 mapのキーは、0から15までのスロット番号の値を、値は、各スロットの初期化パラメータを設定します。

引数
[in]ratingInitParam評価スロットの初期化パラメータ
qBool nn::nex::DataStorePreparePostParam::AddRatingSetting ( qInt8  slot,
const DataStoreRatingInitParam ratingInitParam 
)

評価スロットを一つ追加します。

本パラメータの指定は必須ではありません。デフォルトは未指定ですが、評価機能を利用する場合は 必ず初期化が必要になります。

すでにある評価スロットの設定は残されて、指定された値を追加されます。


戻り値一覧:

true 追加成功

false 同じ slot 番号の要素があって追加に失敗した

void nn::nex::DataStorePreparePostParam::GetRatingSetting ( qMap< qInt8, DataStoreRatingInitParam > &  ratingInitParam) const

評価スロットの初期化設定を取得します。

引数
[out]ratingInitParam評価スロットの初期化パラメータ
void nn::nex::DataStorePreparePostParam::SetMetaBinary ( const void *  p,
size_t  size_ 
)

メタ情報内バイナリデータをセットします。

アップロードするデータにメタ情報として付加するメタ情報内バイナリデータを指定します。 0-1024 バイトまで設定できます。本パラメータの指定は必須ではありません。デフォルトは空です。

引数
[in]pアップロードするデータにメタ情報として付加するバイナリデータのポインタ。NULLを指定すると空になります。
[in]size_アップロードするバイナリデータのデータサイズ(0-1024)。
qVector<qByte> nn::nex::DataStorePreparePostParam::GetMetaBinary ( ) const

メタ情報内バイナリデータを取得します。

戻り値
メタ情報内バイナリデータ
void nn::nex::DataStorePreparePostParam::GetMetaBinary ( qVector< qByte > &  metaBinary_) const

メタ情報内バイナリデータを取得します。

こちらのオーバーロード関数の方が効率的です。

引数
[out]metaBinary_メタ情報内バイナリデータ。
void nn::nex::DataStorePreparePostParam::SetPersistenceInitParam ( const DataStorePersistenceInitParam persistenceInitParam_)

永続化情報をセットします。

引数
[in]persistenceInitParam_永続化情報

データを永続化する場合は、本関数を使用して永続化情報も設定してください。 永続化したデータは有効期限により削除されることはありません。

const DataStorePersistenceInitParam& nn::nex::DataStorePreparePostParam::GetPersistenceInitParam ( ) const

永続化情報を取得します。

戻り値
永続化情報
void nn::nex::DataStorePreparePostParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

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

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