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

コンテンツの取得に関するパラメータを表すクラスです。 [詳解]

#include <RendezVous/Services/Jugem/Subscriber/src/Common/SubscriberGetContentParam.h>

DDLCLASSSubscriberGetContentParamを継承しています。

公開メンバ関数

 SubscriberGetContentParam ()
 コンストラクタです。最低限 SubscriberGetContentParam::SetTopic() で取得するトピックを指定する必要があります。
 
virtual ~SubscriberGetContentParam ()
 デストラクタです。
 
qUnsignedInt64 GetMinimumContentId () const
 取得するコンテンツを限定するための最小のコンテンツ ID を取得します。 [詳解]
 
qUnsignedInt32 GetOffset () const
 何件目から取得するかを表すオフセットを取得します。 [詳解]
 
qUnsignedInt32 GetSize () const
 取得するコンテンツの最大数を取得します。 [詳解]
 
const StringGetTopic () const
 コンテンツを取得する対象のトピックを取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetMinimumContentId (qUnsignedInt64 minimumContentId_)
 取得するコンテンツを限定するための最小のコンテンツ ID を設定します。 [詳解]
 
void SetOffset (qUnsignedInt32 offset_)
 何件目から取得するかを表すオフセットを設定します。 [詳解]
 
void SetSize (qUnsignedInt32 size_)
 取得するコンテンツの最大数を設定します。 [詳解]
 
void SetTopic (const String &topic_)
 コンテンツを取得する対象のトピックを設定します。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 SubscriberGetContentParam オブジェクトの内容をトレースします。 [詳解]
 

詳解

コンテンツの取得に関するパラメータを表すクラスです。

関数詳解

void nn::nex::SubscriberGetContentParam::SetTopic ( const String topic_)

コンテンツを取得する対象のトピックを設定します。

初期状態は空文字列 (無効なトピック名) です。

引数
[in]topic_コンテンツを取得する対象のトピック。
const String& nn::nex::SubscriberGetContentParam::GetTopic ( ) const

コンテンツを取得する対象のトピックを取得します。

戻り値
コンテンツを取得する対象のトピック。
void nn::nex::SubscriberGetContentParam::SetSize ( qUnsignedInt32  size_)

取得するコンテンツの最大数を設定します。

初期値は 20 です。一つのトピックに保持されるコンテンツは SubscriberConstants::MAX_TOPIC_CONTENT_SIZE 件です。 そのため SubscriberConstants::MAX_TOPIC_CONTENT_SIZE 以上のサイズを指定した場合は最大 SubscriberConstants::MAX_TOPIC_CONTENT_SIZE 件取得されます。 SubscriberClient::GetContent() でポーリングする際は 20 以下に設定してください。

引数
[in]size_取得するコンテンツの最大数。
qUnsignedInt32 nn::nex::SubscriberGetContentParam::GetSize ( ) const

取得するコンテンツの最大数を取得します。

戻り値
取得するコンテンツの最大数。
void nn::nex::SubscriberGetContentParam::SetOffset ( qUnsignedInt32  offset_)

何件目から取得するかを表すオフセットを設定します。

何件目から取得するかを表すオフセットを設定します。初期値は 0 です。

引数
[in]offset_何件目から取得するかを表すオフセット。
qUnsignedInt32 nn::nex::SubscriberGetContentParam::GetOffset ( ) const

何件目から取得するかを表すオフセットを取得します。

戻り値
何件目から取得するかを表すオフセット。
void nn::nex::SubscriberGetContentParam::SetMinimumContentId ( qUnsignedInt64  minimumContentId_)

取得するコンテンツを限定するための最小のコンテンツ ID を設定します。

取得するコンテンツを minimumContentId より大きい物のみに限定します。minimumContentId と同じコンテンツ ID のものは含まれません。 SubscriberClient::GetContent() でポーリングする際は同じコンテンツを何度も取得しないように前回取得したコンテンツのうち最も大きいコンテンツ ID 記憶しておき、それを指定してください。 初期値は 0 です。

引数
[in]minimumContentId_取得するコンテンツを限定するための最小のコンテンツ ID。
qUnsignedInt64 nn::nex::SubscriberGetContentParam::GetMinimumContentId ( ) const

取得するコンテンツを限定するための最小のコンテンツ ID を取得します。

戻り値
取得するコンテンツを限定するための最小のコンテンツ ID。
void nn::nex::SubscriberGetContentParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

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

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