Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

IPresenceSubscription

Reference the IPresenceSubscription interface for subscribing to user presence.
Read time 1 minuteLast updated 2 days ago
More... 
#include <IPresenceSubscription.h>

Public Functions

Name

DECLARE_EVENT_OneParam(IPresenceSubscription , AfterLocationAdded , const IPresenceLocation & )
virtual ILoginSession &LoginSession() =0
virtual TMap< FString, IPresenceLocation * >Locations() const =0

Public Attributes

Name

AfterLocationUpdated
const IPresenceLocation &virtual DECLARE_EVENT_OneParam(IPresenceSubscription, BeforeLocationRemoved, const IPresenceLocation &) public const AccountId &() const =0SubscribedAccount
AfterLocationAddedEventAfterLocationAdded
AfterLocationUpdatedEventAfterLocationUpdated
BeforeLocationRemovedEventBeforeLocationRemoved

Detailed Description

class IPresenceSubscription;
A subscription to another user for online status.

Public Functions Documentation

function DECLARE_EVENT_OneParam

DECLARE_EVENT_OneParam(    IPresenceSubscription ,    AfterLocationAdded ,    const IPresenceLocation & )

function LoginSession

virtual ILoginSession & LoginSession() =0
The login session that owns this subscription.

function Locations

virtual TMap< FString, IPresenceLocation * > Locations() const =0
If the account associated with this subscription is signed in, then the Locations map has an entry for the location of each login session for that user.

Public Attributes Documentation

variable AfterLocationUpdated

AfterLocationUpdated;

variable SubscribedAccount

const IPresenceLocation &virtual DECLARE_EVENT_OneParam(IPresenceSubscription, BeforeLocationRemoved, const IPresenceLocation &) public const AccountId &() const =0 SubscribedAccount;
The account that this subscription pertains to.

variable EventAfterLocationAdded

AfterLocationAdded EventAfterLocationAdded;
This event is raised after a device has been added to the Locations() collection.

variable EventAfterLocationUpdated

AfterLocationUpdated EventAfterLocationUpdated;
This event is raised after a device has been added to the Locations() collection.

variable EventBeforeLocationRemoved

BeforeLocationRemoved EventBeforeLocationRemoved;
This event is raised before a device is removed from the Locations() collection.