EOS_Sessions_SendInvite

EOS API reference page for EOS_Sessions_SendInvite

3 mins to read

This function is part of the Sessions Interface.

Remarks

Send an invite to another player. User must have created the session or be registered in the session or else the call will fail

Return Value

  • EOS_Success if the send invite completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_NotFound if the session to send the invite from does not exist

Parameters

EOS_Sessions_SendInvite

Parameter Type And NameUsage Information
EOS_HSessions Handle
const EOS_Sessions_SendInviteOptions* OptionsStructure containing information about the session and player to invite
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Sessions_OnSendInviteCallback CompletionDelegateA callback that is fired when the send invite operation completes, either successfully or in error

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_SendInvite

Callback Parameters

EOS_Sessions_OnSendInviteCallback

Parameter Type And NameUsage Information
const EOS_Sessions_SendInviteCallbackInfo* DataA EOS_Sessions_SendInviteCallbackInfo containing the output information and result