Edit

Lobby.ForceRemoveMember method

  • Article

Forcibly remove an entity from the lobby.

public void ForceRemoveMember(PFEntityKey targetMember, bool preventRejoin)
parameter description
targetMember The member to forcibly remove.
preventRejoin A flag indicating whether targetMember will be prevented from rejoining the lobby after being removed.

Remarks

This is an asynchronous operation. Upon successful completion, the title is provided a OnLobbyMemberRemoved event followed by a OnForceRemoveMemberCompleted event with the OnForceRemoveMemberCompleted result field set to Success. Upon a failed completion, the title is provided a OnForceRemoveMemberCompleted event with the OnForceRemoveMemberCompleted result field set to a failed error code.

One of the local PlayFab entities present in this lobby must be the owner for this operation to succeed. If the local owning entity who initiated this operation loses their ownership status while the operation is in progress, the operation fails asynchronously.

This is an asynchronous operation. The member removed via this method will not be removed from the lists returned by GetMembers until the asynchronous operation successfully completes and a OnLobbyMemberRemoved event is generated.

See Also