Diarkis C++Client Library API Document
Diarkis::DiarkisRoomChatLogEventArgs Struct Reference

Arguments of callback events called when received the result of Diarkis::Modules::IDiarkisRoom::GetChatLog() More...

#include <eventArgs.h>

Public Member Functions

bool IsSuccess () const
 Get whether the command was successful or not. More...
 
const StdVector< std::shared_ptr< RoomChatData > > & GetChatLists () const
 Get history of chat messages. More...
 
const StdVector< uint8_t > & GetPayload () const
 Get the received payload. More...
 
uint16_t GetErrorCode () const
 Get error code. More...
 
const Diarkis::StdStringGetErrorMessage () const
 Gets the contents of the error. More...
 
 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
 

Detailed Description

Arguments of callback events called when received the result of Diarkis::Modules::IDiarkisRoom::GetChatLog()

Constructor & Destructor Documentation

◆ 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

Member Function Documentation

◆ IsSuccess()

bool Diarkis::DiarkisRoomChatLogEventArgs::IsSuccess ( ) const

Get whether the command was successful or not.

true=success false=failure

Here is the caller graph for this function:

◆ GetChatLists()

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

Get history of chat messages.

Here is the caller graph for this function:

◆ GetPayload()

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

Get the received payload.

◆ GetErrorCode()

uint16_t Diarkis::DiarkisRoomChatLogEventArgs::GetErrorCode ( ) const

Get error code.

Return 0 if IsSuccess()=true.

Here is the caller graph for this function:

◆ GetErrorMessage()

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

Gets the contents of the error.

Here is the caller graph for this function:

The documentation for this struct was generated from the following file: