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

Arguments of the callback event called when the group is created. More...

#include <eventArgs.h>

Public Member Functions

bool IsSuccess () const
 Get whether the command was successful or not. More...
 
const Diarkis::StdString & GetGroupID () const
 Get the group ID. More...
 
uint16_t GetErrorCode () const
 Get error code. More...
 
const Diarkis::StdString & GetErrorMessage () const
 Gets the contents of the error. More...
 
 DiarkisGroupEventArgs (bool isSuccess, const Diarkis::StdString &groupID, uint16_t errorCode, const Diarkis::StdString &errorString)
 
 DiarkisGroupEventArgs (DiarkisGroupEventArgs &)=delete
 
 DiarkisGroupEventArgs (DiarkisGroupEventArgs &&)=delete
 

Detailed Description

Arguments of the callback event called when the group is created.

Constructor & Destructor Documentation

◆ DiarkisGroupEventArgs() [1/3]

Diarkis::DiarkisGroupEventArgs::DiarkisGroupEventArgs ( bool  isSuccess,
const Diarkis::StdString &  groupID,
uint16_t  errorCode,
const Diarkis::StdString &  errorString 
)

◆ DiarkisGroupEventArgs() [2/3]

Diarkis::DiarkisGroupEventArgs::DiarkisGroupEventArgs ( DiarkisGroupEventArgs &  )
delete

◆ DiarkisGroupEventArgs() [3/3]

Diarkis::DiarkisGroupEventArgs::DiarkisGroupEventArgs ( DiarkisGroupEventArgs &&  )
delete

Member Function Documentation

◆ IsSuccess()

bool Diarkis::DiarkisGroupEventArgs::IsSuccess ( ) const

Get whether the command was successful or not.

true=success false=failure

Here is the caller graph for this function:

◆ GetGroupID()

const Diarkis::StdString& Diarkis::DiarkisGroupEventArgs::GetGroupID ( ) const

Get the group ID.

Here is the caller graph for this function:

◆ GetErrorCode()

uint16_t Diarkis::DiarkisGroupEventArgs::GetErrorCode ( ) const

Get error code.

Return 0 if IsSuccess()=true.

Here is the caller graph for this function:

◆ GetErrorMessage()

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