AccelByte.Api.GameTelemetry Class Reference

Send telemetry data securely and the game user should be logged in. More...

Inheritance diagram for AccelByte.Api.GameTelemetry:

Public Member Functions
void	SetUseCache (bool isUseCache, bool clearCurrentCache=false)
	Enable or disable write operations to the file storage cache. The cache stores all events in JSON format as a file to be sent on service initialization (can be disabled via client config editor) or SendCachedTelemetry(callback) in case of crash, errors, or unclean game/app termination. The cache is enabled by default and can also be configured via client config editor.
void	SetBatchFrequency (TimeSpan interval)
	Set the interval of sending telemetry event to the backend. By default it sends the queued events once a minute. Should not be less than 5 seconds.
void	SetBatchFrequency (int intervalSeconds)
	Set the interval of sending telemetry event to the backend. By default it sends the queued events once a minute. Should not be less than 5 seconds.
void	SetImmediateEventList (List< string > eventList)
	Set list of event that need to be sent immediately without the needs to jobQueue it.
void	Send (TelemetryBody telemetryBody, ResultCallback callback)
	Send/enqueue a single authorized telemetry data. Server should be logged in. See DedicatedServer.LoginWithClientCredentials().
void	SendTelemetryBatch (ResultCallback callback)
	Send telemetry data in the batch.
void	SendCachedTelemetry (ResultCallback callback)
	Send cached telemetry events.

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator [get]

Detailed Description

Send telemetry data securely and the game user should be logged in.

Member Function Documentation

Send()

void AccelByte.Api.GameTelemetry.Send ( TelemetryBody telemetryBody, ResultCallback callback )

inline

Send/enqueue a single authorized telemetry data. Server should be logged in. See DedicatedServer.LoginWithClientCredentials().

Parameters

telemetryBody	Telemetry request with arbitrary payload.
callback	Returns boolean status via callback when completed.

SendCachedTelemetry()

void AccelByte.Api.GameTelemetry.SendCachedTelemetry ( ResultCallback callback )

inline

Send cached telemetry events.

Parameters

callback

Returns a result via callback when operation is done

SendTelemetryBatch()

void AccelByte.Api.GameTelemetry.SendTelemetryBatch ( ResultCallback callback )

inline

Send telemetry data in the batch.

Parameters

callback

Callback after sending telemetry data is complete

SetBatchFrequency() [1/2]

void AccelByte.Api.GameTelemetry.SetBatchFrequency ( int intervalSeconds )

inline

Set the interval of sending telemetry event to the backend. By default it sends the queued events once a minute. Should not be less than 5 seconds.

Parameters

intervalSeconds

The seconds interval between telemetry event.

SetBatchFrequency() [2/2]

void AccelByte.Api.GameTelemetry.SetBatchFrequency ( TimeSpan interval )

inline

Set the interval of sending telemetry event to the backend. By default it sends the queued events once a minute. Should not be less than 5 seconds.

Parameters

interval

The interval between telemetry event.

SetImmediateEventList()

void AccelByte.Api.GameTelemetry.SetImmediateEventList ( List< string > eventList )

inline

Set list of event that need to be sent immediately without the needs to jobQueue it.

Parameters

eventList

String list of payload EventName.

SetUseCache()

void AccelByte.Api.GameTelemetry.SetUseCache ( bool isUseCache, bool clearCurrentCache = false )

inline

Enable or disable write operations to the file storage cache. The cache stores all events in JSON format as a file to be sent on service initialization (can be disabled via client config editor) or SendCachedTelemetry(callback) in case of crash, errors, or unclean game/app termination. The cache is enabled by default and can also be configured via client config editor.

Parameters

isUseCache	Enables or disables cache write operations.
clearCurrentCache	Clears currently built up cache if true.