AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender Class Reference

#include <PostConnectSynchronizeStateSender.h>

Inheritance diagram for alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender:
Collaboration graph
[legend]

Public Member Functions

 ~PostConnectSynchronizeStateSender ()
 
void onContextAvailable (const std::string &jsonContext) override
 
void onContextFailure (const avsCommon::sdkInterfaces::ContextRequestError error) override
 
unsigned int getOperationPriority () override
 
bool performOperation (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender) override
 
void abortOperation () override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface
virtual ~ContextRequesterInterface ()=default
 
virtual void onContextAvailable (const endpoints::EndpointIdentifier &endpointId, const avs::AVSContext &endpointContext, ContextRequestToken requestToken)
 
virtual void onContextFailure (const ContextRequestError error, ContextRequestToken token)
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface
virtual ~PostConnectOperationInterface ()=default
 
virtual bool performOperation (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender)=0
 

Static Public Member Functions

static std::shared_ptr< PostConnectSynchronizeStateSendercreate (std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder=nullptr)
 

Additional Inherited Members

- Static Public Attributes inherited from alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface
static constexpr unsigned int VERIFY_GATEWAY_PRIORITY = 50
 Operation priority for AVS Gateway Verification. More...
 
static constexpr unsigned int ENDPOINT_DISCOVERY_PRIORITY = 100
 Operation priority for Publishing Capabilities to AVS. More...
 
static constexpr unsigned int SYNCHRONIZE_STATE_PRIORITY = 150
 Operation priority for sending SynchronizeState event to AVS. More...
 

Detailed Description

A Post connect operation to send the SynchronizeState event.

Constructor & Destructor Documentation

◆ ~PostConnectSynchronizeStateSender()

alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender::~PostConnectSynchronizeStateSender ( )

Destructor.

Member Function Documentation

◆ abortOperation()

void alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender::abortOperation ( )
overridevirtual

PostConnectOperationInterface Methods.

Implements alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface.

◆ create()

static std::shared_ptr<PostConnectSynchronizeStateSender> alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender::create ( std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface contextManager,
std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface metricRecorder = nullptr 
)
static

Creates a new instance of the PostConnectSynchronizeStateSender.

Parameters
contextManagerThe ContextManager to request the context from.
metricRecorderThe object used for metric recording.
Returns
a new instance of the PostConnectSynchronizeStateSender.

◆ getOperationPriority()

unsigned int alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender::getOperationPriority ( )
overridevirtual

PostConnectOperationInterface Methods.

Implements alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface.

◆ onContextAvailable()

void alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender::onContextAvailable ( const std::string &  jsonContext)
overridevirtual

ContextRequesterInterface Methods.

Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface.

◆ onContextFailure()

void alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender::onContextFailure ( const avsCommon::sdkInterfaces::ContextRequestError  error)
overridevirtual

ContextRequesterInterface Methods.

Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface.

◆ performOperation()

bool alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender::performOperation ( const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &  messageSender)
override

PostConnectOperationInterface Methods.


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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0