AccelByte.Api.HeartBeat Class Reference

Send heart beat event. More...

Inheritance diagram for AccelByte.Api.HeartBeat:

Public Member Functions
void	SetHeartbeatInterval (int newIntervalMs)
void	AddSendData (string key, string data)
	Add heartbeat send information.
bool	RemoveSendData (string key)
	Remove heartbeat send information.
void	SetHeartBeatEnabled (bool enable)
	Enables or disables heart beat.
void	SetHeartBeatCallback (ResultCallback callback)
	set heart beat response callback

Properties
bool	IsHeartBeatJobRunning [get]
bool	IsHeartBeatJobEnabled [get]
Dictionary< string, object >	HeartBeatData [get]
int	HeartBeatIntervalMs [get]
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator [get]

Detailed Description

Send heart beat event.

Member Function Documentation

AddSendData()

void AccelByte.Api.HeartBeat.AddSendData ( string key, string data )

inline

Add heartbeat send information.

Parameters

key	Data key
data	Data value

RemoveSendData()

bool AccelByte.Api.HeartBeat.RemoveSendData ( string key )

inline

Remove heartbeat send information.

Parameters

key

Data key

Returns

true: Successfully removed

false: Key not found removed