EOS API reference page for EOS_Sessions_RejectInvite

This function is part of the Sessions Interface.


Reject an invite from another player.

Return Value

  • EOS_Success if the invite rejection completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_NotFound if the invite does not exist


Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_RejectInviteOptions* Options

Structure containing information about the invite to reject

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Sessions_OnRejectInviteCallback CompletionDelegate

A callback that is fired when the reject 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.

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_RejectInvite

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Sessions_RejectInviteCallbackInfo* Data

A EOS_Sessions_RejectInviteCallbackInfo containing the output information and result

Related API Members