API reference

OVR_PartyUpdateNotification.h File

Typedefs

struct ovrPartyUpdateNotification * ovrPartyUpdateNotificationHandle

Functions

ovrPartyUpdateAction ovr_PartyUpdateNotification_GetAction
An enum that specifies the type of action related to the party and user that this notification holds.ovrPartyUpdateAction_Join: The user is going to join the party.ovrPartyUpdateAction_Leave: The user is going to leave the party.ovrPartyUpdateAction_Invite: The user is invited to the party.ovrPartyUpdateAction_Uninvite: The user is uninvited from the party.
ovrID ovr_PartyUpdateNotification_GetPartyId
The Id of the party that will be updated. This can be retrieved with ovrPartyIDHandle.
ovrID ovr_PartyUpdateNotification_GetSenderId
The id of the ovrUserHandle who initiated the action that this party update status notification is in reference to. This is equivalent to ovr_User_GetID() for this user.
const char * ovr_PartyUpdateNotification_GetUpdateTimestamp
A timestamp denoting when the action happened that this status update notification refers to.
const char * ovr_PartyUpdateNotification_GetUserAlias
The alias of the ovrUserHandle whose party status has changed.
ovrID ovr_PartyUpdateNotification_GetUserId
The ID of the user whose party status has changed.
const char * ovr_PartyUpdateNotification_GetUserName
The displayable name of the ovrUserHandle whose party status has changed. This is equivalent to ovr_User_GetDisplayName() for this user.