nn::nex::ParticipationEvents::ParticipationEvents Enumerated Type

Syntax

enum ParticipationEvents;

Value

Value Description
Participate Indicates that a client has joined to participate in a gathering. This event is notified to the gathering when a client joins the gathering via the MatchmakeExtensionClient::CreateMatchmakeSession, MatchmakeExtensionClient::JoinMatchmakeSession, or MatchmakeExtensionClient::AutoMatchmake function.
CancelParticipation Not used.
Invite Not used.
AcceptInvitation Not used.
DeclineInvitation Not used.
CancelInvitation Not used.
Disconnect Indicates that a client has logged out. The gathering is notified of this event when a client logs out before leaving the gathering.
EndParticipation Indicates that a client has left the gathering. The gathering is notified of this event when a client leaves the gathering by calling the MatchmakeExtensionClient::EndParticipation function.
FirstUserEvent Not used.

Description

Enumerated type that defines the details of status changes of participants in a gathering.

Enumerator that defines the details of events that are notified to the owner or participants of a gathering when there has been a change to the status of the participants in the gathering (for example, when a participant joins or leaves). By default, only the owner is notified of Participate, Disconnect, and EndParticipation events. However, the owner is not notified of changes to the state of the owner's station. The GatheringFlags::NotifyParticipationEventsToAllParticipants and GatheringFlags::NotifyParticipationEventsToAllParticipantsReproducibly flags can be used to change notifications so that all participants, including the local station, are notified.

Revision History

2014/03/19
Fixed the incorrect statement that the owner was notified of changes to the owner's station. Added the ability to notify all participants, including the owner, by using the GatheringFlags::NotifyParticipationEventsToAllParticipants and GatheringFlags::NotifyParticipationEventsToAllParticipantsReproducibly flags of all Participate, Disconnect, and EndParticipation events.
2012/02/14
Initial version.

CONFIDENTIAL