enum NotificationEvents;
Value | Description |
---|---|
FriendEvent | Not used. |
SessionLaunched | Not used. |
ParticipationEvent | Event notifying the owner or participant 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). The event details (its subtype) are defined by ParticipationEvents . Get the GatheringID triggered by the event with the NotificationEvent::GetParam1 function, the PrincipalID of the client that joined or left with the NotificationEvent::GetParam2 function, and the accompanying message with the NotificationEvent::GetStringParam function. |
OwnershipChangeEvent | Event notification to all the participants in a gathering when the owner of the gathering has changed. Get the GatheringID triggered by the event with the NotificationEvent::GetParam1 function and the PrincipalID of the new owner with the NotificationEvent::GetParam2 function. |
FriendStatusChangeEvent | Not used. |
ForceDisconnectEvent | Not used. |
GameSessionEvent | Not used. |
ForceDisconnectPrincipalEvent | Not used. |
ForceDisconnectAllPrincipalsEvent | Not used. |
GameNotificationType1 | Event notification to friends who are logged in to the same game server. The application can freely define both the timing of the notification and data in the notification. |
GameNotificationType2 | Game-defined event 2. |
GameNotificationType3 | Game-defined event 3. |
GameNotificationType4 | Game-defined event 4. |
GameNotificationType5 | Game-defined event 5. |
GameNotificationType6 | Game-defined event 6. |
GameNotificationType7 | Game-defined event 7. |
GameNotificationType8 | Game-defined event 8. |
GatheringUnregistered | Event notification to all the participants in a gathering when the gathering has been deleted. Get the GatheringID triggered by the event with the NotificationEvent::GetParam1 function. |
HostChangeEvent | Notify the previous host when changing the host of a gathering. Get the GatheringID triggered by the event with the NotificationEvent::GetParam1 function. |
GameNotificationLogout | Event notification to friends when logging out from the game server, when a game-defined event has been set. For this case, logging out includes non-explicit logouts such as when power is lost. |
SubscriptionEvent | Specifies an event dispatched when a subscription occurs. |
GameServerMaintenance | Specifies an event dispatched when game server maintenance begins. |
MaintenanceAnnouncement | Specifies an event dispatched when a game server maintenance announcement is made. The NotificationEvent::GetParam1 function gets the maintenance start time in Unix Epoch Time. The server maintenance time in UTC can be retrieved using the DateTime::FromUnixEpochTime function. |
SystemEvent | Specifies an event for use within the library. This event is not sent to the application. |
RoundStarted | Event notification to all round participants when the round starts. Use NotificationEvent::GetUInt64Param1 to get the round ID. |
FirstRoundReportReceived | Event notification to all round participants when the server receives the first round report. Use NotificationEvent::GetUInt64Param1 to get the round ID. |
RoundSummarized | Event notification to all round participants when round summarizing has completed. Use NotificationEvent::GetUInt64Param1 to get the round ID. |
MatchmakeSystemConfigurationNotification | Notification event to use for matchmaking. This event is not sent to the application. |
MatchmakeSessionSystemPasswordSet | This event notifies all participants of a session when a system password is set for the matchmaking session. Use the NotificationEvent::GetStringParam function to get the matchmaking session system password. |
MatchmakeSessionSystemPasswordClear | This event notifies all participants of a session when the system password for the matchmaking session is cleared. |
AddedToGathering | Indicates that the local station was added to the gathering. This notice is sent by other users to the user that was added to the gathering by one of the following functions: MatchmakeExtensionClient::AutoMatchmake , MatchmakeExtensionClient::JoinMatchmakeSession , or MatchmakeExtensionClient::CreateMatchmakeSession . Get the added gathering ID with the NotificationEvent::GetParam1 function and the principal ID of the added user (that is, the principal ID of the local station) with the NotificationEvent::GetParam2 function. The NotificationEvent::GetStringParam function gets the join message specified when the user that triggered the event joined the session. The NotificationEvent::GetSource function can be used to get the principal ID of the user who called the RMC. |
SharedLocalCacheUpdated | Specifies an event for use within the library. This event is not sent to the application. |
FirstUserNotification | Not used. |
Enumerated type defining the types of notification events.
Enumerated type defining the types of notification events. Sets the NotificationEvent
class object passed to the NotificationEventHandlerProcessNotificationEvent
function.
MatchmakeSessionSystemPasswordSet
event occurs.MatchmakeSessionSystemPasswordSet
, MatchmakeSessionSystemPasswordClear
, and AddedToGathering
.RoundStarted
, FirstRoundReportReceived
, and RoundSummarized
.GameServerMaintenance
and MaintenanceAnnouncement
.
ForceDisconnectAllPrincipalsEvent
.CONFIDENTIAL