PartyNetwork::RevokeInvitation

Queues an asynchronous attempt to revoke an invitation from the network.

Syntax

PartyError RevokeInvitation(  
    const PartyLocalUser* localUser,  
    PartyInvitation* invitation,  
    void* asyncIdentifier  
)  

Parameters

localUser   PartyLocalUser*

The local user attempting to revoke the invitation.

invitation   PartyInvitation*

The invitation to revoke.

asyncIdentifier   void*

An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.

Return value

PartyError

c_partyErrorSuccess if the asynchronous operation to revoke the invitation began, or an error code otherwise. If this method fails, no related state changes will be generated. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

Titles may revoke an invitation to prevent further users from authenticating into a network using the invitation's identifier.

This method queues an asynchronous attempt to revoke an invitation from the network. A PartyRevokeInvitationCompletedStateChange will be provided upon completion of the asynchronous operation, indicating success or failure. On success, a PartyInvitationDestroyedStateChange will have been generated beforehand with PartyDestroyedReason::Requested, to indicate that the network will no longer accept authentications using the invitation's identifier until a new invitation is created with that same identifier. It also indicates that the invitation will no longer be queryable via GetInvitations().

This operation will only succeed if the invitation was created with its revocability specified such that the localUser on the local device may revoke the invitation. This might not be the case if the revocability is set to PartyInvitationRevocability::Creator and the localUser is authenticated on a different device than the creator or if the localUser refers to a different user than the creator.

Requirements

Header: Party.h

See also

PartyNetwork
PartyRevokeInvitationCompletedStateChange
PartyInvitationDestroyedStateChange