CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
inet_NexJoinCommunitySetting.h
1 /*--------------------------------------------------------------------------------*
2  Copyright (C)Nintendo All rights reserved.
3 
4  These coded instructions, statements, and computer programs contain proprietary
5  information of Nintendo and/or its licensed developers and are protected by
6  national and international copyright laws. They may not be disclosed to third
7  parties or copied or duplicated in any form, in whole or in part, without the
8  prior written consent of Nintendo.
9 
10  The content herein is highly confidential and should be handled accordingly.
11  *--------------------------------------------------------------------------------*/
12 
13 
14 #pragma once
15 
16 #include <nn/pia/inet/inet_Definitions.h>
17 
18 #if NN_PIA_ENABLE_NEX
19 
20 #include <nn/pia/inet/inet_NexSessionTypes.h>
21 
22 #include <nn/pia/common/common_FixedString.h>
23 #include <nn/pia/session/session_JoinCommunitySetting.h>
24 
25 namespace nn
26 {
27 namespace pia
28 {
29 namespace inet
30 {
31 /*!
32  @brief コミュニティ参加処理に関する設定を管理するクラスです。
33 
34  @see session::JoinCommunitySetting
35  */
37 {
38 public:
39  /*!
40  @brief デフォルトコンストラクタ。
41  */
43 
44  /*!
45  @brief デストラクタ。
46  */
47  virtual ~NexJoinCommunitySetting();
48 
49  /*!
50  @brief 参加するコミュニティのユーザーパスワードを設定します。
51  @param[in] userPassword 設定するユーザーパスワード。パスワードの文字列は SessionUserPasswordLengthMax 以下である必要があります。
52  @return ユーザーパスワードの指定に成功すれば、成功の Result が返されます。
53 
54  @retval nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはユーザーパスワードの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
55  */
56  Result SetCommunityUserPassword(const common::String& userPassword);
57 
58  /*!
59  @cond PRIVATE
60  @brief 指定したユーザーパスワードを取得します。
61  @return 指定したユーザーパスワードを返します。
62  */
63  const common::String& GetCommunityUserPassword() const;
64  //! @endcond
65 
66  /*!
67  @brief 代入演算子です。
68  @param[in] rhs 代入するオブジェクトです。
69  @return 本オブジェクトへの参照。
70  */
72 
73  /*!
74  @brief 設定をコピーします。
75  @param[in] rhs コピー元のオブジェクトです。
76  */
77  void Copy(const NexJoinCommunitySetting& rhs);
78 
79  /*!
80  @brief コピーコンストラクタ。
81  @param[in] rhs コピー元のオブジェクトです。
82  */
84 
85  /*!
86  @brief 設定をリセットします。
87  */
88  virtual void Reset();
89 
90  // デバッグに有用な情報をプリント。
91  void Trace(uint64_t flag) const;
92 
93 protected:
95 
96 private:
97 };
98 }
99 }
100 } // end of namespace nn::pia::inet
101 
102 #endif