Diarkis C++Client Library API Document
Public Member Functions | List of all members
Diarkis::DiarkisRoomPayloadEventArgs Struct Reference

Arguments of callback events called when executing Room Regiser, Reserve, etc. More...

#include <eventArgs.h>

Public Member Functions

bool IsSuccess () const
 Get whether the command was successful or not. More...
 
const StdVector< uint8_t > & GetPayload () const
 Get the received payload. More...
 
uint16_t GetErrorCode () const
 Get error code. More...
 
const Diarkis::StdString & GetErrorMessage () const
 Gets the contents of the error. More...
 
 DiarkisRoomPayloadEventArgs (bool isSuccess_, const StdVector< uint8_t > &payload_, uint16_t errorCode, const Diarkis::StdString &errorString)
 
 DiarkisRoomPayloadEventArgs (DiarkisRoomPayloadEventArgs &)=delete
 
 DiarkisRoomPayloadEventArgs (DiarkisRoomPayloadEventArgs &&)=delete
 

Detailed Description

Arguments of callback events called when executing Room Regiser, Reserve, etc.

Constructor & Destructor Documentation

◆ DiarkisRoomPayloadEventArgs() [1/3]

Diarkis::DiarkisRoomPayloadEventArgs::DiarkisRoomPayloadEventArgs ( bool  isSuccess_,
const StdVector< uint8_t > &  payload_,
uint16_t  errorCode,
const Diarkis::StdString &  errorString 
)

◆ DiarkisRoomPayloadEventArgs() [2/3]

Diarkis::DiarkisRoomPayloadEventArgs::DiarkisRoomPayloadEventArgs ( DiarkisRoomPayloadEventArgs &  )
delete

◆ DiarkisRoomPayloadEventArgs() [3/3]

Diarkis::DiarkisRoomPayloadEventArgs::DiarkisRoomPayloadEventArgs ( DiarkisRoomPayloadEventArgs &&  )
delete

Member Function Documentation

◆ IsSuccess()

bool Diarkis::DiarkisRoomPayloadEventArgs::IsSuccess ( ) const

Get whether the command was successful or not.

true=success false=failure

Here is the caller graph for this function:

◆ GetPayload()

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

Get the received payload.

Here is the caller graph for this function:

◆ GetErrorCode()

uint16_t Diarkis::DiarkisRoomPayloadEventArgs::GetErrorCode ( ) const

Get error code.

Return 0 if IsSuccess()=true.

Here is the caller graph for this function:

◆ GetErrorMessage()

const Diarkis::StdString& Diarkis::DiarkisRoomPayloadEventArgs::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: