![]() |
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
This class implements a CapabilityAgent
that handles the SetEndpoint
directive.
More...
#include <UserInactivityMonitor.h>
Static Public Member Functions | |
static std::shared_ptr< avsCommon::sdkInterfaces::UserInactivityMonitorInterface > | createUserInactivityMonitorInterface (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionEncounteredSender, const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &shutdownNotifier, const std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > &directiveSequencer, const std::chrono::milliseconds &sendPeriod=std::chrono::hours(1)) |
static std::shared_ptr< UserInactivityMonitor > | create (std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender, const std::chrono::milliseconds &sendPeriod=std::chrono::hours(1)) |
Additional Inherited Members | |
![]() | |
CapabilityAgent (const std::string &nameSpace, std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender) | |
virtual std::shared_ptr< DirectiveInfo > | createDirectiveInfo (std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result) |
virtual void | preHandleDirective (std::shared_ptr< DirectiveInfo > info)=0 |
virtual void | handleDirective (std::shared_ptr< DirectiveInfo > info)=0 |
virtual void | cancelDirective (std::shared_ptr< DirectiveInfo > info)=0 |
void | removeDirective (const std::string &messageId) |
void | sendExceptionEncounteredAndReportFailed (std::shared_ptr< DirectiveInfo > info, const std::string &message, avsCommon::avs::ExceptionErrorType type=avsCommon::avs::ExceptionErrorType::INTERNAL_ERROR) |
const std::pair< std::string, std::string > | buildJsonEventString (const std::string &eventName, const std::string &dialogRequestIdString="", const std::string &payload="{}", const std::string &context="") const |
![]() | |
const std::string | m_namespace |
The namespace of the capability agent. More... | |
std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface > | m_exceptionEncounteredSender |
Object to use to send exceptionEncountered messages. More... | |
This class implements a CapabilityAgent
that handles the SetEndpoint
directive.
|
override |
|
override |
|
static |
Create an instance of UserInactivityMonitor
.
messageSender | The MessageSenderInterface for sending events. |
exceptionEncounteredSender | The interface that sends exceptions. |
sendPeriod | The period of send events in seconds. |
nullptr
if the inputs are not defined, else a new instance of UserInactivityMonitor
.
|
static |
Create an instance of UserInactivityMonitorInterface
.
messageSender | The MessageSenderInterface for sending events. |
exceptionEncounteredSender | The interface that sends exceptions. |
shutdownNotifier | The ShutdownNotifierInterface that will notify this instance when it is time to shut down. |
directiveSequencer | The DirectiveSequencerInterface with which to register this instance as a directive handler. |
sendPeriod | The period of send events in seconds. |
nullptr
if the inputs are not defined, else a new instance of UserInactivityMonitor
.
|
overridevirtual |
Returns the configuration of the directive handler.
The configuration consists of multiple directive routing rules and their respective blocking policy. The directives will be matched from the most specific rule (with all fields defined) to the least specific rule (which only matches the directive endpointId).
avs::DirectiveHandlerConfiguration
of the handler. Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface.
|
override |
|
overridevirtual |
Handle the action specified AVSDirective
. Once this has been called the DirectiveHandler
should not expect to receive further calls regarding this directive.
AVSDirectives
. ExceptionEncountered
message should be sent to AVS.directive | The directive to handle. |
Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface.
|
overridevirtual |
The function to be called when the user has become active.
Implements alexaClientSDK::avsCommon::sdkInterfaces::UserInactivityMonitorInterface.
|
override |
|
override |
|
overridevirtual |
Calculates how many seconds have elapsed since a user last interacted with the device.
Implements alexaClientSDK::avsCommon::sdkInterfaces::UserInactivityMonitorInterface.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0