EOS API reference page for EOS_CustomInvites_SendCustomInvite

2 分で読めます

This function is part of the CustomInvites Interface.


Sends a Custom Invite that has previously been initialized via SetCustomInvite to a group of users.

Return Value

  • EOS_Success if the query completes successfully

  • EOS_InvalidParameters if any of the options values are incorrect

  • EOS_TooManyRequests if the number of allowed queries is exceeded

  • EOS_NotFound if SetCustomInvite has not been previously successfully called for this user



Parameter Type And NameUsage Information
EOS_HCustomInvites Handle
const EOS_CustomInvites_SendCustomInviteOptions* OptionsStructure containing information about the request.
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_CustomInvites_OnSendCustomInviteCallback CompletionDelegateA callback that is fired when the operation completes, either successfully or in error

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_CustomInvites_SendCustomInvite

Callback Parameters


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