EOS API reference page for EOS_Friends_RejectInvite

This function is part of the Friends Interface.


Starts an asynchronous task that rejects a friend invitation from another user. The completion delegate is executed after the backend response has been received.


Parameter Type And Name

Usage Information

EOS_HFriends Handle

const EOS_Friends_RejectInviteOptions* Options

structure containing the logged in account and the inviting account

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Friends_OnRejectInviteCallback CompletionDelegate

a callback that is fired when the async 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_Friends_OnRejectInviteCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Friends_RejectInvite

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Friends_RejectInviteCallbackInfo* Data

A EOS_Friends_RejectInviteCallbackInfo containing output information and the result.

Related API Members