API reference
API reference
Select your platform
No SDKs available
No versions available

FOvrPartyUpdateNotification Struct

The notification about updating a party status information to a participating user. Party Notifications are intended to update the user on various actions that are occurring in the user's party. This is primarily used in {'party_update': 'FOvrNotification_Party_PartyUpdate'}.

Constructors

FOvrPartyUpdateNotification ()
This is the default constructor for the struct, which initializes the ovrPartyUpdateNotificationHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrPartyUpdateNotification::FOvrPartyUpdateNotification()
FOvrPartyUpdateNotification ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrPartyUpdateNotification::FOvrPartyUpdateNotification(ovrPartyUpdateNotificationHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters

Fields

An enum that specifies the type of action related to the party and user that this notification holds. It can be retrieved by using field FOvrPartyUpdateNotification::Action.
EOvrPartyUpdateAction::Join: The user is going to join the party.
EOvrPartyUpdateAction::Leave: The user is going to leave the party.
EOvrPartyUpdateAction::Invite: The user is invited to the party.
EOvrPartyUpdateAction::Uninvite: The user is uninvited from the party.
Signature
EOvrPartyUpdateAction FOvrPartyUpdateNotification::Action
PartyId : FOvrId
The ID of the party that will be updated. This can be retrieved with FOvrPartyID.
Signature
FOvrId FOvrPartyUpdateNotification::PartyId
SenderId : FOvrId
The id of the FOvrUser who initiated the action that this party update status notification is in reference to. This is equivalent to field FOvrUser::ID for this user.
Signature
FOvrId FOvrPartyUpdateNotification::SenderId
UpdateTimestamp : FString
A timestamp denoting when the party action occurred that this status update notification refers to.
Signature
FString FOvrPartyUpdateNotification::UpdateTimestamp
UserAlias : FString
The alias of the FOvrUser whose party status has changed. This is an alias that is set by the user.
Signature
FString FOvrPartyUpdateNotification::UserAlias
UserId : FOvrId
The ID of the user, field FOvrUser::ID, whose party status has changed. This is a unique value for every FOvrUser.
Signature
FOvrId FOvrPartyUpdateNotification::UserId
UserName : FString
The displayable name of the FOvrUser whose party status has changed. This is equivalent to field FOvrUser::DisplayName for this user.
Signature
FString FOvrPartyUpdateNotification::UserName

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrPartyUpdateNotification::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrPartyUpdateNotification::Update(ovrPartyUpdateNotificationHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
Returns
void