Diarkis C++Client Library API Document
Diarkis::DiarkisRoomChatLogEventArgs 構造体

Diarkis::Modules::IDiarkisRoom::GetChatLog()の結果を受信した際に呼び出されるコールバックイベントの引数 [詳解]

#include <eventArgs.h>

公開メンバ関数

bool IsSuccess () const
 コマンドが成功したかどうかを取得します。 [詳解]
 
const StdVector< std::shared_ptr< RoomChatData > > & GetChatLists () const
 チャットメッセージの履歴を取得する [詳解]
 
const StdVector< uint8_t > & GetPayload () const
 受信したペイロードを取得する [詳解]
 
uint16_t GetErrorCode () const
 エラーコードを取得します。 [詳解]
 
const Diarkis::StdStringGetErrorMessage () const
 エラーの内容を取得します。 [詳解]
 
 DiarkisRoomChatLogEventArgs (bool isSuccess_, const StdVector< std::shared_ptr< RoomChatData >> &chatLists_, const StdVector< uint8_t > &payload_, uint16_t errorCode, const Diarkis::StdString &errorString)
 
 DiarkisRoomChatLogEventArgs (DiarkisRoomChatLogEventArgs &)=delete
 
 DiarkisRoomChatLogEventArgs (DiarkisRoomChatLogEventArgs &&)=delete
 

詳解

Diarkis::Modules::IDiarkisRoom::GetChatLog()の結果を受信した際に呼び出されるコールバックイベントの引数

構築子と解体子

◆ DiarkisRoomChatLogEventArgs() [1/3]

Diarkis::DiarkisRoomChatLogEventArgs::DiarkisRoomChatLogEventArgs ( bool  isSuccess_,
const StdVector< std::shared_ptr< RoomChatData >> &  chatLists_,
const StdVector< uint8_t > &  payload_,
uint16_t  errorCode,
const Diarkis::StdString errorString 
)

◆ DiarkisRoomChatLogEventArgs() [2/3]

Diarkis::DiarkisRoomChatLogEventArgs::DiarkisRoomChatLogEventArgs ( DiarkisRoomChatLogEventArgs )
delete

◆ DiarkisRoomChatLogEventArgs() [3/3]

Diarkis::DiarkisRoomChatLogEventArgs::DiarkisRoomChatLogEventArgs ( DiarkisRoomChatLogEventArgs &&  )
delete

関数詳解

◆ IsSuccess()

bool Diarkis::DiarkisRoomChatLogEventArgs::IsSuccess ( ) const

コマンドが成功したかどうかを取得します。

true=成功 false=失敗

被呼び出し関係図:

◆ GetChatLists()

const StdVector<std::shared_ptr<RoomChatData> >& Diarkis::DiarkisRoomChatLogEventArgs::GetChatLists ( ) const

チャットメッセージの履歴を取得する

被呼び出し関係図:

◆ GetPayload()

const StdVector<uint8_t>& Diarkis::DiarkisRoomChatLogEventArgs::GetPayload ( ) const

受信したペイロードを取得する

◆ GetErrorCode()

uint16_t Diarkis::DiarkisRoomChatLogEventArgs::GetErrorCode ( ) const

エラーコードを取得します。

IsSuccess()=trueの場合は0を返します。

被呼び出し関係図:

◆ GetErrorMessage()

const Diarkis::StdString& Diarkis::DiarkisRoomChatLogEventArgs::GetErrorMessage ( ) const

エラーの内容を取得します。

被呼び出し関係図:

この構造体詳解は次のファイルから抽出されました: