alexaClientSDK::acsdkExternalMediaPlayer::AuthorizedSender Class Reference

#include <AuthorizedSender.h>

Inheritance diagram for alexaClientSDK::acsdkExternalMediaPlayer::AuthorizedSender:

Collaboration diagram for alexaClientSDK::acsdkExternalMediaPlayer::AuthorizedSender:

Public Member Functions
	~AuthorizedSender () override
void	updateAuthorizedPlayers (const std::unordered_set< std::string > &playerIds)
MessageSenderInterface Functions.
void	sendMessage (std::shared_ptr< avsCommon::avs::MessageRequest > request) override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface
virtual	~MessageSenderInterface ()=default
	Destructor. More...
virtual void	sendMessage (std::shared_ptr< avs::MessageRequest > request)=0

Static Public Member Functions
static std::shared_ptr< AuthorizedSender >	create (std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender)

Detailed Description

If an adapter/player is not authorized, it is not allowed to send events or be mentioned in the Context. This class parses the MessageRequest JSON and sends the message if the sender has an authorized playerId. This also means that this class will block events that do not have a playerId field in the payload. By default, no players are authorized.

Constructor & Destructor Documentation

~AuthorizedSender()

alexaClientSDK::acsdkExternalMediaPlayer::AuthorizedSender::~AuthorizedSender ( )

override

Member Function Documentation

create()

static std::shared_ptr<AuthorizedSender> alexaClientSDK::acsdkExternalMediaPlayer::AuthorizedSender::create ( std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface >  messageSender )

static

Creates an instance of the AuthorizedSender.

Parameters

messageSender

Sends messages to the cloud.

Returns

A valid instance if creation was successful, else a nullptr.

sendMessage()

void alexaClientSDK::acsdkExternalMediaPlayer::AuthorizedSender::sendMessage ( std::shared_ptr< avsCommon::avs::MessageRequest >  request )

override

updateAuthorizedPlayers()

void alexaClientSDK::acsdkExternalMediaPlayer::AuthorizedSender::updateAuthorizedPlayers

(

const std::unordered_set< std::string > &

playerIds

)

Update the list of authorized players that are allowed to send messages.

Parameters

playerIds

The authorized players.

---

The documentation for this class was generated from the following file:

• /workplace/avs-device-sdk/capabilities/ExternalMediaPlayer/acsdkExternalMediaPlayer/include/acsdkExternalMediaPlayer/AuthorizedSender.h