EOS API reference page for EOS_Friends_SendInvite

2 mins to read

This function is part of the Friends Interface.


Starts an asynchronous task that sends a friend invitation to another user. The completion delegate is executed after the backend response has been received. It does not indicate that the target user has responded to the friend invitation.



Parameter Type And NameUsage Information
EOS_HFriends Handle
const EOS_Friends_SendInviteOptions* Optionsstructure containing the account to send the invite from and the account to send the invite to
void* ClientDataarbitrary data that is passed back to you in the CompletionDelegate
const EOS_Friends_OnSendInviteCallback CompletionDelegatea callback that is fired when the async operation completes, either successfully or in error

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Friends_SendInvite

Callback Parameters


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