Choose your implementation method:
This function is part of the Lobby Interface.
Send an invite to another user. User must be a member of the lobby 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 lobby to send the invite from does not exist
Parameters
EOS_Lobby_SendInvite
|
Parameter Type And Name
|
Usage Information
|
|
EOS_HLobby Handle
|
|
|
const EOS_Lobby_SendInviteOptions* Options
|
Structure containing information about the lobby and user to invite
|
|
void* ClientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
|
const EOS_Lobby_OnSendInviteCallback CompletionDelegate
|
A callback that is fired when the send invite 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.
Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnSendInviteCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Lobby_SendInvite
Callback Parameters
EOS_Lobby_OnSendInviteCallback
|
Parameter Type And Name
|
Usage Information
|
|
const EOS_Lobby_SendInviteCallbackInfo* Data
|
A EOS_Lobby_SendInvite CallbackInfo containing the output information and result
|
This function is part of the Lobby Interface.
Send an invite to another user. User must be a member of the lobby or else the call will fail
{Result.InvalidParameters} if any of the options are incorrect
{Result.NotFound} if the lobby to send the invite from does not exist
Return Value
{Result.Success} if the send invite completes successfully
Parameters
Lobby.LobbyInterface.SendInvite
|
Parameter Type And Name
|
Usage Information
|
|
SendInviteOptions options
|
Structure containing information about the lobby and user to invite
|
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
|
OnSendInviteCallback completionDelegate
|
A callback that is fired when the send invite 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.
Because this function is asynchronous, it employs a callback of type Lobby.OnSendInviteCallback to report the results of its operation.
Function prototype definition for callbacks passed to {LobbyInterface.SendInvite}
Callback Parameters
Lobby.OnSendInviteCallback
|
Parameter Type And Name
|
Usage Information
|
|
SendInviteCallbackInfo data
|
A EOS_Lobby_SendInvite CallbackInfo containing the output information and result
|
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no