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

PartyUpdateNotification Class

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. It can be retrieved using com.meta.horizon.platform.ovr.Message.MessageType#Notification_Party_PartyUpdate.

Constructors

PartyUpdateNotification ( ptr )
Signature
com.meta.horizon.platform.ovr.models.PartyUpdateNotification.PartyUpdateNotification(final long ptr)
Parameters
ptr: final long

Methods

getAction ()
An enum that specifies the type of action related to the party and user that this notification holds.
com.meta.horizon.platform.ovr.enums.PartyUpdateAction#Join: The user joined the party.
com.meta.horizon.platform.ovr.enums.PartyUpdateAction#Leave: The user left the party.
com.meta.horizon.platform.ovr.enums.PartyUpdateAction#Invite: The user was invited to the party.
com.meta.horizon.platform.ovr.enums.PartyUpdateAction#Uninvite: The user was uninvited to the party.
Signature
PartyUpdateAction com.meta.horizon.platform.ovr.models.PartyUpdateNotification.getAction()
Returns
PartyUpdateAction  PartyUpdateAction
getPartyId ()
The ID of the party that will be updated. This can be retrieved with com.meta.horizon.platform.ovr.models.PartyID.
Signature
long com.meta.horizon.platform.ovr.models.PartyUpdateNotification.getPartyId()
Returns
long  long
getSenderId ()
The id of the com.meta.horizon.platform.ovr.models.User who initiated the action that this party update status notification is in reference to. This is equivalent to com.meta.horizon.platform.ovr.models.User#getID() for this user.
Signature
long com.meta.horizon.platform.ovr.models.PartyUpdateNotification.getSenderId()
Returns
long  long
getUpdateTimestamp ()
A timestamp denoting when the party action occurred that this status update notification refers to.
Signature
String com.meta.horizon.platform.ovr.models.PartyUpdateNotification.getUpdateTimestamp()
Returns
String  String
getUserAlias ()
The alias of the com.meta.horizon.platform.ovr.models.User whose party status has changed. This is an alias that is set by the user.
Signature
String com.meta.horizon.platform.ovr.models.PartyUpdateNotification.getUserAlias()
Returns
String  String
getUserId ()
The ID of the user, com.meta.horizon.platform.ovr.models.User#getID(), whose party status has changed. This is a unique value for every com.meta.horizon.platform.ovr.models.User.
Signature
long com.meta.horizon.platform.ovr.models.PartyUpdateNotification.getUserId()
Returns
long  long
getUserName ()
The displayable name of the com.meta.horizon.platform.ovr.models.User whose party status has changed. This is equivalent to com.meta.horizon.platform.ovr.models.User#getDisplayName() for this user.
Signature
String com.meta.horizon.platform.ovr.models.PartyUpdateNotification.getUserName()
Returns
String  String