EOS_Stats_IngestStat

EOS API reference page for EOS_Stats_IngestStat

Choose your implementation method:

C

C#

This function is part of the Stats Interface.

Remarks

Ingest a stat by the amount specified in Options. When the operation is complete and the delegate is triggered the stat will be uploaded to the backend to be processed. The stat may not be updated immediately and an achievement using the stat may take a while to be unlocked once the stat has been uploaded.

Return Value

  • EOS_Success if the operation completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_InvalidUser if target user ID is missing or incorrect

Parameters

EOS_Stats_IngestStat

Parameter Type And Name

Usage Information

EOS_HStats Handle

const EOS_Stats_IngestStatOptions* Options

Structure containing information about the stat we're ingesting.

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate.

const EOS_Stats_OnIngestStatCompleteCallback CompletionDelegate

This function is called when the ingest stat operation completes.

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Stats_OnIngestStatCompleteCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Stats_IngestStat

Callback Parameters

EOS_Stats_OnIngestStatCompleteCallback

Parameter Type And Name

Usage Information

const EOS_Stats_IngestStatCompleteCallbackInfo* Data

A EOS_Stats_IngestStatCompleteCallbackInfo containing the output information and result

Related API Members

This function is part of the Stats Interface.

Remarks

Ingest a stat by the amount specified in Options. When the operation is complete and the delegate is triggered the stat will be uploaded to the backend to be processed. The stat may not be updated immediately and an achievement using the stat may take a while to be unlocked once the stat has been uploaded. {Result.InvalidParameters} if any of the options are incorrect {Result.InvalidUser} if target user ID is missing or incorrect

Return Value

{Result.Success} if the operation completes successfully

Parameters

Stats.StatsInterface.IngestStat

Parameter Type And Name

Usage Information

IngestStatOptions options

Structure containing information about the stat we're ingesting.

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate.

OnIngestStatCompleteCallback completionDelegate

This function is called when the ingest stat operation completes.

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type Stats.OnIngestStatCompleteCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to {StatsInterface.IngestStat}

Callback Parameters

Stats.OnIngestStatCompleteCallback

Parameter Type And Name

Usage Information

IngestStatCompleteCallbackInfo data

A EOS_Stats_IngestStatCompleteCallbackInfo containing the output information and result

Related API Members

Tags