Open 3D Engine Presence Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
Presence::PresenceNotifications Class Referenceabstract

EBUS interface used to listen for presence request events. More...

#include <PresenceNotificationBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual void OnPresenceSet (const AzFramework::LocalUserId &localUserId)=0
 
virtual void OnPresenceQueried (const PresenceDetails &presenceDetails)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 EBus Trait: presence notifications can be handled by multiple listeners.
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 EBus Trait: presence notifications are addressed to a single address.
 

Detailed Description

EBUS interface used to listen for presence request events.

Member Function Documentation

◆ OnPresenceQueried()

virtual void Presence::PresenceNotifications::OnPresenceQueried ( const PresenceDetails &  presenceDetails)
pure virtual

Override to be notified when presence has been successfully queried. Unsuccessful attempts are logged.

Parameters
[in]structrepresenting presence details populated by query request

◆ OnPresenceSet()

virtual void Presence::PresenceNotifications::OnPresenceSet ( const AzFramework::LocalUserId &  localUserId)
pure virtual

Override to be notified when presence has been successfully set. Unsuccessful attempts are logged.

Parameters
[in]thelocal user ID for the user whose presence has been set.
The documentation for this class was generated from the following file: