メッセージデータを格納するクラスです。 [詳解]
#include <RendezVous/Core/src/Common/UserMessage.h>
公開メンバ関数 | |
UserMessage () | |
コンストラクタです。 | |
const DateTime & | GetReceptionTime () const |
メッセージの受信時刻を取得します。 [詳解] | |
GatheringID | GetRecipientGatheringID () const |
メッセージの送信時に送信先としてセットされた ギャザリング ID を返します。 [詳解] | |
PrincipalID | GetRecipientPrincipalID () const |
メッセージの送信時に送信先としてセットされた プリンシパル ID を返します。 [詳解] | |
IdentifierTypes::Types | GetRecipientType () const |
GetRecipientPrincipalID(), GetRecipientGatheringID() どちらの関数を呼ぶ出すべきかを判断するための ID のタイプを返します。 [詳解] | |
PrincipalID | GetSenderID () const |
メッセージの送信元の PrincipalID を取得します。 [詳解] | |
const String & | GetSubject () const |
メッセージの Subject を取得します。 [詳解] | |
void | SetSubject (const String &strSubject) |
メッセージの Subject をセットします。 MESSAGING_STRING_MAX_LENGTH 文字( NULL終端含まず ) を超えるテキストは、 インスタントメッセージング機能では使用できません。サーバー送信時にエラーとなります。 [詳解] | |
静的公開メンバ関数 | |
static Data * | DynamicCast (Data *pData) |
Dataクラスポインタの動的キャストを行います。 [詳解] | |
メッセージデータを格納するクラスです。
インスタントメッセージング機能を利用する場合は本クラス、TextMessage 、BinaryMessage のいずれかのクラスを利用してください。
const DateTime& nn::nex::UserMessage::GetReceptionTime | ( | ) | const |
メッセージの受信時刻を取得します。
ゲームサーバーがメッセージを受信した時刻、すなわち送信元が送信した時刻を取得します。 クライアントがメッセージを受信した時刻ではないことに注意してください。
時刻は UTC でセットされています。
PrincipalID nn::nex::UserMessage::GetSenderID | ( | ) | const |
メッセージの送信元の PrincipalID を取得します。
PrincipalID nn::nex::UserMessage::GetRecipientPrincipalID | ( | ) | const |
メッセージの送信時に送信先としてセットされた プリンシパル ID を返します。
GetRecipientType() が返す ID のタイプが IdentifierTypes::PIDType の場合に使用します。 MessagingClient::SendInstant() で送信された場合はプリンシパル ID が返ります。 MessagingClient::SendChat() で送信された場合は INVALID_PRINCIPALID が返ります。
GatheringID nn::nex::UserMessage::GetRecipientGatheringID | ( | ) | const |
メッセージの送信時に送信先としてセットされた ギャザリング ID を返します。
GetRecipientType() が返す IDのタイプ が IdentifierTypes::GIDType の場合に使用します。 MessagingClient::SendInstant() で送信された場合は INVALID_GATHERINGID が返ります。 MessagingClient::SendChat() で送信された場合は ギャザリング ID が返ります。
IdentifierTypes::Types nn::nex::UserMessage::GetRecipientType | ( | ) | const |
GetRecipientPrincipalID(), GetRecipientGatheringID() どちらの関数を呼ぶ出すべきかを判断するための ID のタイプを返します。
const String& nn::nex::UserMessage::GetSubject | ( | ) | const |
メッセージの Subject を取得します。
void nn::nex::UserMessage::SetSubject | ( | const String & | strSubject | ) |
メッセージの Subject をセットします。 MESSAGING_STRING_MAX_LENGTH 文字( NULL終端含まず ) を超えるテキストは、 インスタントメッセージング機能では使用できません。サーバー送信時にエラーとなります。
[in] | strSubject | メッセージの Subject |
Dataクラスポインタの動的キャストを行います。
本関数は、DDLコンパイラによってDDLで定義されたDataクラスの派生クラスに自動的に作成されます。
各クラスで定義された同名関数を呼び出すことで、引数で指定されたポインタを各クラスの型のポインタに動的にキャストします。 たとえば、UserMessage::DynamicCast() であれば、引数で指定したData*型のポインタをUserMessage*に動的にキャストします。 キャスト可能であれば有効なポインタを返し、キャスト不可能であればNULLを返します。
本関数による動的キャストは独自に実装しているので、RTTIを有効にする必要はありません。
[in] | pData | Dataクラスの派生クラスのポインタを指定します。 |