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

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

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

DDLCLASSJoinMatchmakeSessionParamを継承しています。

公開メンバ関数

 JoinMatchmakeSessionParam ()
 コンストラクタです。 [詳解]
 
virtual ~JoinMatchmakeSessionParam ()
 デストラクタです。
 
const qList< PrincipalID > & GetAdditionalParticipants () const
 追加で参加させるユーザーを取得します。 [詳解]
 
const MatchmakeBlockListParamGetBlockListParam () const
 ブロックリストの挙動を指定するパラメータを取得します。 [詳解]
 
GatheringID GetGatheringIdForParticipationCheck () const
 自分と追加で参加させるがユーザーが指定したギャザリングに参加しているかを確認するためのギャザリング ID を取得します。 [詳解]
 
JoinMatchmakeSessionBehavior GetJoinMatchmakeSessionBehavior () const
 JoinMatchmakeSessionBehavior で列挙される参加に関する振る舞いを取得します。 [詳解]
 
const StringGetJoinMessage () const
 ギャザリングのオーナーもしくは参加者に通知されるメッセージを取得します。 [詳解]
 
const StringGetSystemPassword () const
 マッチメイクセッションシステムパスワードを取得します。 [詳解]
 
GatheringID GetTargetGatheringId () const
 参加する対象のギャザリング ID を取得します。 [詳解]
 
const StringGetUserPassword () const
 マッチメイクセッションユーザーパスワードを取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetAdditionalParticipant (const qList< PrincipalID > &additionalParticipants_)
 追加で参加させるユーザーを設定します。 [詳解]
 
void SetBlockListParam (const MatchmakeBlockListParam &blockListParam_)
 ブロックリストの挙動を指定するパラメータを設定します。 [詳解]
 
void SetGatheringIdForParticipationCheck (GatheringID gidForParticipationCheck_)
 自分と追加で参加させるがユーザーが指定したギャザリングに参加しているかを確認するためのギャザリング ID を設定します。 [詳解]
 
void SetJoinMatchmakeSessionBehavior (JoinMatchmakeSessionBehavior joinMatchmakeSessionBehavior_)
 JoinMatchmakeSessionBehavior で列挙される参加に関する振る舞いを設定します。 [詳解]
 
void SetJoinMessage (const String &joinMessage_)
 ギャザリングのオーナーもしくは参加者に通知されるメッセージを設定します。 [詳解]
 
void SetSystemPassword (const String &strSystemPassword_)
 マッチメイクセッションシステムパスワードを設定します。 [詳解]
 
void SetTargetGatheringId (GatheringID gid_)
 参加する対象のギャザリング ID を設定します。 [詳解]
 
void SetUserPassword (const String &strUserPassword_)
 マッチメイクセッションユーザーパスワードを設定します。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 JoinMatchmakeSessionParam オブジェクトの内容をトレースします。 [詳解]
 

詳解

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

構築子と解体子

nn::nex::JoinMatchmakeSessionParam::JoinMatchmakeSessionParam ( )

コンストラクタです。

コンストラクタです。最低限 JoinMatchmakeSessionParam::SetTargetGatheringId() で参加したいギャザリング ID を指定する必要があります。

関数詳解

void nn::nex::JoinMatchmakeSessionParam::SetTargetGatheringId ( GatheringID  gid_)

参加する対象のギャザリング ID を設定します。

初期状態は INVALID_GATHERINGID です。

引数
[in]gid_参加する対象のギャザリング ID
GatheringID nn::nex::JoinMatchmakeSessionParam::GetTargetGatheringId ( ) const

参加する対象のギャザリング ID を取得します。

戻り値
参加する対象のギャザリング ID 。
void nn::nex::JoinMatchmakeSessionParam::SetAdditionalParticipant ( const qList< PrincipalID > &  additionalParticipants_)

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

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

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

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

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

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

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

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

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

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

マッチメイクセッションユーザーパスワードを設定します。

マッチメイクセッションにユーザーパスワードがセットされている場合に一致が確認されます。 初期状態は空文字列です。

引数
[in]strUserPassword_マッチメイクセッションユーザーパスワード。
参照
MatchmakeSession::SetUserPassword()
const String& nn::nex::JoinMatchmakeSessionParam::GetUserPassword ( ) const

マッチメイクセッションユーザーパスワードを取得します。

戻り値
マッチメイクセッションユーザーパスワード。
void nn::nex::JoinMatchmakeSessionParam::SetSystemPassword ( const String strSystemPassword_)

マッチメイクセッションシステムパスワードを設定します。

マッチメイクセッションにシステムパスワードがセットされている場合に一致が確認されます。 初期状態は空文字列です。

引数
[in]strSystemPassword_マッチメイクセッションシステムパスワード。
参照
MatchmakeExtensionClient::GenerateMatchmakeSessionSystemPassword()
const String& nn::nex::JoinMatchmakeSessionParam::GetSystemPassword ( ) const

マッチメイクセッションシステムパスワードを取得します。

戻り値
マッチメイクセッションシステムパスワード。
void nn::nex::JoinMatchmakeSessionParam::SetJoinMatchmakeSessionBehavior ( JoinMatchmakeSessionBehavior  joinMatchmakeSessionBehavior_)

JoinMatchmakeSessionBehavior で列挙される参加に関する振る舞いを設定します。

初期状態は JOIN_MATCHMAKE_SESSION_BEHAVIOR_JOIN_MYSELF です。

引数
[in]joinMatchmakeSessionBehavior_参加に関する振る舞い。
JoinMatchmakeSessionBehavior nn::nex::JoinMatchmakeSessionParam::GetJoinMatchmakeSessionBehavior ( ) const

JoinMatchmakeSessionBehavior で列挙される参加に関する振る舞いを取得します。

戻り値
参加に関する振る舞い。
void nn::nex::JoinMatchmakeSessionParam::SetJoinMessage ( const String joinMessage_)

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

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

引数
[in]joinMessage_ギャザリングのオーナーもしくは参加者に通知されるメッセージ。
参照
MatchmakeExtensionClient::GetDetailedParticipants()
const String& nn::nex::JoinMatchmakeSessionParam::GetJoinMessage ( ) const

ギャザリングのオーナーもしくは参加者に通知されるメッセージを取得します。

戻り値
ギャザリングのオーナーもしくは参加者に通知されるメッセージ。
void nn::nex::JoinMatchmakeSessionParam::SetBlockListParam ( const MatchmakeBlockListParam blockListParam_)

ブロックリストの挙動を指定するパラメータを設定します。

マッチメイクセッションへ参加する際にブロックリストのチェックを行うかどうかを指定するパラメータを設定します。 blockListParam_ の初期状態は MatchmakeBlockListParam::SetUseMyBlockList(true) および MatchmakeBlockListParam::SetUseBlockListByOthers(true) された状態です。

引数
[in]blockListParam_ブロックリストの挙動を指定するパラメータ。
const MatchmakeBlockListParam& nn::nex::JoinMatchmakeSessionParam::GetBlockListParam ( ) const

ブロックリストの挙動を指定するパラメータを取得します。

戻り値
ブロックリストの挙動を指定するパラメータ。
void nn::nex::JoinMatchmakeSessionParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

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

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