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

MatchmakeExtensionClient::CreateMatchmakeSession() に関するパラメータを格納するデータクラスです。 [詳解]

#include <RendezVous/Services/Jugem/Matchmake/src/Common/CreateMatchmakeSessionParam.h>

DDLCLASSCreateMatchmakeSessionParamを継承しています。

公開メンバ関数

 CreateMatchmakeSessionParam ()
 コンストラクタです。 [詳解]
 
virtual ~CreateMatchmakeSessionParam ()
 デストラクタです。
 
const qList< PrincipalID > & GetAdditionalParticipants () const
 追加で参加させるユーザーを取得します。 [詳解]
 
GatheringID GetGatheringIdForParticipationCheck () const
 自分と追加で参加させるがユーザーが指定したギャザリングに参加しているかを確認するためのギャザリング ID を取得します。 [詳解]
 
const StringGetJoinMessage () const
 設定によりギャザリングの参加者に通知されるメッセージを取得します。 [詳解]
 
const MatchmakeSessionGetSourceMatchmakeSession () const
 作成するマッチメイクセッションを取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetAdditionalParticipant (const qList< PrincipalID > &additionalParticipants_)
 追加で参加させるユーザーを設定します。 [詳解]
 
void SetGatheringIdForParticipationCheck (GatheringID gidForParticipationCheck_)
 自分と追加で参加させるがユーザーが指定したギャザリングに参加しているかを確認するためのギャザリング ID を設定します。 [詳解]
 
void SetJoinMessage (const String &joinMessage_)
 設定によりギャザリングの参加者に通知されるメッセージを設定します。 [詳解]
 
void SetSourceMatchmakeSession (const MatchmakeSession &sourceMatchmakeSession_)
 作成するマッチメイクセッションを設定します。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 CreateMatchmakeSessionParam オブジェクトの内容をトレースします。 [詳解]
 

詳解

MatchmakeExtensionClient::CreateMatchmakeSession() に関するパラメータを格納するデータクラスです。

構築子と解体子

nn::nex::CreateMatchmakeSessionParam::CreateMatchmakeSessionParam ( )

コンストラクタです。

コンストラクタです。最低限 CreateMatchmakeSessionParam::SetSourceMatchmakeSession() で作成するマッチメイクセッションを設定する必要があります。

関数詳解

void nn::nex::CreateMatchmakeSessionParam::SetSourceMatchmakeSession ( const MatchmakeSession sourceMatchmakeSession_)

作成するマッチメイクセッションを設定します。

sourceMatchmakeSession に指定したパラメータでマッチメイクセッションを作成します。

引数
[in]sourceMatchmakeSession_作成するマッチメイクセッション。
const MatchmakeSession& nn::nex::CreateMatchmakeSessionParam::GetSourceMatchmakeSession ( ) const

作成するマッチメイクセッションを取得します。

戻り値
作成するマッチメイクセッション。
void nn::nex::CreateMatchmakeSessionParam::SetAdditionalParticipant ( const qList< PrincipalID > &  additionalParticipants_)

追加で参加させるユーザーを設定します。

自分が参加すると同時に他人も同時にマッチメイクセッションに参加させたい場合、本関数でそのプリンシパル ID を指定します。 例えば、フレンドとチームを組んで対戦したいといった場合に利用できます。 対象のユーザーは NGS にログインしている必要があります。 追加で参加したユーザに対しては NotificationEvents::AddedToGathering の通知が送信されます。 追加で参加したユーザは MatchmakeExtensionClient::FindMatchmakeSessionByGatheringIdDetail() で P2P 通信用の共通鍵を含んだマッチメイクセッションの詳細情報を取得できます。 初期状態は空です。

引数
[in]additionalParticipants_追加で参加させるユーザー。
参照
CreateMatchmakeSessionParam::SetGatheringIdForParticipationCheck()
const qList<PrincipalID>& nn::nex::CreateMatchmakeSessionParam::GetAdditionalParticipants ( ) const

追加で参加させるユーザーを取得します。

戻り値
追加で参加させるユーザー。
void nn::nex::CreateMatchmakeSessionParam::SetGatheringIdForParticipationCheck ( GatheringID  gidForParticipationCheck_)

自分と追加で参加させるがユーザーが指定したギャザリングに参加しているかを確認するためのギャザリング ID を設定します。

自分を含む参加者全員が特定のギャザリングに参加している事を条件とする場合は本関数でそのギャザリング ID を指定します。 初期状態は INVALID_GATHERINGID です。

引数
[in]gidForParticipationCheck_参加を条件とするギャザリングの ID 。INVALID_GATHERINGID を指定するとチェックは行われません。
参照
CreateMatchmakeSessionParam::SetAdditionalParticipant()
GatheringID nn::nex::CreateMatchmakeSessionParam::GetGatheringIdForParticipationCheck ( ) const

自分と追加で参加させるがユーザーが指定したギャザリングに参加しているかを確認するためのギャザリング ID を取得します。

戻り値
参加を条件とするギャザリングの ID 。
void nn::nex::CreateMatchmakeSessionParam::SetJoinMessage ( const String joinMessage_)

設定によりギャザリングの参加者に通知されるメッセージを設定します。

このメッセージはユーザーごとにサーバーに保存され、MatchmakeExtensionClient::GetDetailedParticipants() で取得できます。 CreateMatchmakeSessionParam::SetAdditionalParticipant() で参加させたユーザーのメッセージも本関数で設定したものになります。 初期状態は空文字列です。

引数
[in]joinMessage_設定によりギャザリングの参加者に通知されるメッセージ。
参照
MatchmakeExtensionClient::GetDetailedParticipants()
const String& nn::nex::CreateMatchmakeSessionParam::GetJoinMessage ( ) const

設定によりギャザリングの参加者に通知されるメッセージを取得します。

戻り値
設定によりギャザリングの参加者に通知されるメッセージ。
void nn::nex::CreateMatchmakeSessionParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

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

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