EOS_CustomInvites_SendCustomInvite

EOS API reference page for EOS_CustomInvites_SendCustomInvite

Choose your implementation method:

C

C#

This function is part of the CustomInvites Interface.

Remarks

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

Parameters

EOS_CustomInvites_SendCustomInvite

Parameter Type And Name

Usage Information

EOS_HCustomInvites Handle

const EOS_CustomInvites_SendCustomInviteOptions* Options

Structure containing information about the request.

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_CustomInvites_OnSendCustomInviteCallback CompletionDelegate

A callback that is fired when the operation completes, either successfully or in error

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_CustomInvites_OnSendCustomInviteCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_CustomInvites_SendCustomInvite

Callback Parameters

EOS_CustomInvites_OnSendCustomInviteCallback

Parameter Type And Name

Usage Information

const EOS_CustomInvites_SendCustomInviteCallbackInfo* Data

A EOS_CustomInvites_SendCustomInviteCallbackInfo containing the output information and result

Related API Members

This function is part of the CustomInvites Interface.

Remarks

Sends a Custom Invite that has previously been initialized via SetCustomInvite to a group of users. {Result.InvalidParameters} if any of the options values are incorrect {Result.TooManyRequests} if the number of allowed queries is exceeded {Result.NotFound} if SetCustomInvite has not been previously successfully called for this user

Return Value

{Result.Success} if the query completes successfully

Parameters

CustomInvites.CustomInvitesInterface.SendCustomInvite

Parameter Type And Name

Usage Information

SendCustomInviteOptions options

Structure containing information about the request.

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnSendCustomInviteCallback completionDelegate

A callback that is fired when the operation completes, either successfully or in error

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 CustomInvites.OnSendCustomInviteCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to {CustomInvitesInterface.SendCustomInvite}

Callback Parameters

CustomInvites.OnSendCustomInviteCallback

Parameter Type And Name

Usage Information

SendCustomInviteCallbackInfo data

A EOS_CustomInvites_SendCustomInviteCallbackInfo containing the output information and result

Related API Members