Diarkis::DiarkisRoomIncrementPropertyEventArgs Struct Reference

Argument of the callback event called when the value of the Room property is increased or decreased. More...

#include <eventArgs.h>

Public Member Functions
bool	IsSuccess () const
	Get whether the command was successful or not. More...
int64_t	GetDelta () const
	Increase/decrease value of property. More...
const Diarkis::StdString &	GetPropertyName () const
	Get the property name. More...
uint16_t	GetErrorCode () const
	Get error code. More...
const Diarkis::StdString &	GetErrorMessage () const
	Gets the contents of the error. More...
	DiarkisRoomIncrementPropertyEventArgs (bool isSuccess_, const int64_t delta_, const Diarkis::StdString &name, uint16_t errorCode, const Diarkis::StdString &errorString)
	DiarkisRoomIncrementPropertyEventArgs (DiarkisRoomIncrementPropertyEventArgs &)=delete
	DiarkisRoomIncrementPropertyEventArgs (DiarkisRoomIncrementPropertyEventArgs &&)=delete

Detailed Description

Argument of the callback event called when the value of the Room property is increased or decreased.

Constructor & Destructor Documentation

DiarkisRoomIncrementPropertyEventArgs() [1/3]

Diarkis::DiarkisRoomIncrementPropertyEventArgs::DiarkisRoomIncrementPropertyEventArgs	(	bool	isSuccess_,
		const int64_t	delta_,
		const Diarkis::StdString &	name,
		uint16_t	errorCode,
		const Diarkis::StdString &	errorString
	)

DiarkisRoomIncrementPropertyEventArgs() [2/3]

Diarkis::DiarkisRoomIncrementPropertyEventArgs::DiarkisRoomIncrementPropertyEventArgs ( DiarkisRoomIncrementPropertyEventArgs &  )

delete

DiarkisRoomIncrementPropertyEventArgs() [3/3]

Diarkis::DiarkisRoomIncrementPropertyEventArgs::DiarkisRoomIncrementPropertyEventArgs ( DiarkisRoomIncrementPropertyEventArgs &&  )

delete

Member Function Documentation

IsSuccess()

bool Diarkis::DiarkisRoomIncrementPropertyEventArgs::IsSuccess

(

)

const

Get whether the command was successful or not.

true=success false=failure

Here is the caller graph for this function:

GetDelta()

int64_t Diarkis::DiarkisRoomIncrementPropertyEventArgs::GetDelta

(

)

const

Increase/decrease value of property.

Here is the caller graph for this function:

GetPropertyName()

const Diarkis::StdString& Diarkis::DiarkisRoomIncrementPropertyEventArgs::GetPropertyName

(

)

const

Get the property name.

Here is the caller graph for this function:

GetErrorCode()

uint16_t Diarkis::DiarkisRoomIncrementPropertyEventArgs::GetErrorCode

(

)

const

Get error code.

Return 0 if IsSuccess()=true.

Here is the caller graph for this function:

GetErrorMessage()

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

• client/cpp/libDiarkis/include/diarkis/network/eventArgs.h