Steve Pham
38261d0800
* Updated all copyright headers to split the longer original copyright line into 2 shorter lines Signed-off-by: Steve Pham <spham@amazon.com>
43 lines
2.0 KiB
C++
43 lines
2.0 KiB
C++
/*
|
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
*
|
|
*/
|
|
#pragma once
|
|
#include <AzFramework/Input/User/LocalUserId.h>
|
|
#include <AzCore/EBus/EBus.h>
|
|
#include <AzCore/std/string/string.h>
|
|
|
|
namespace Presence
|
|
{
|
|
////////////////////////////////////////////////////////////////////////////////////////
|
|
//! EBUS interface used to listen for presence request events
|
|
class PresenceNotifications
|
|
: public AZ::EBusTraits
|
|
{
|
|
public:
|
|
////////////////////////////////////////////////////////////////////////////////////////////
|
|
//! EBus Trait: presence notifications can be handled by multiple listeners
|
|
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////
|
|
//! EBus Trait: presence notifications are addressed to a single address
|
|
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////
|
|
//! Override to be notified when presence has been successfully set. Unsuccessful attempts
|
|
//! are logged.
|
|
//! \param[in] the local user ID for the user whose presence has been set.
|
|
virtual void OnPresenceSet(const AzFramework::LocalUserId& localUserId) = 0;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////
|
|
//! Override to be notified when presence has been successfully queried. Unsuccessful attempts
|
|
//! are logged.
|
|
//! \param[in] struct representing presence details populated by query request
|
|
virtual void OnPresenceQueried(const PresenceDetails& presenceDetails) = 0;
|
|
};
|
|
using PresenceNotificationBus = AZ::EBus<PresenceNotifications>;
|
|
} // namespace Presence
|