AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgent Member List

This is the complete list of members for alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgent, including all inherited members.

addObserver(const std::shared_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface > &observer) overridealexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >inlinevirtual
addWeakPtrObserver(const std::weak_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface > &observer) overridealexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >inlinevirtual
BaseAPLCapabilityAgent(const std::string &avsNamespace, std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionSender, std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder, std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, const std::string &APLMaxVersion, std::shared_ptr< alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface > visualStateProvider=nullptr)alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgent
buildJsonEventString(const std::string &eventName, const std::string &dialogRequestIdString="", const std::string &payload="{}", const std::string &context="") constalexaClientSDK::avsCommon::avs::CapabilityAgentprotected
cancelDirective(std::shared_ptr< DirectiveInfo > info) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
alexaClientSDK::avsCommon::avs::CapabilityAgent::cancelDirective(const std::string &messageId) override finalalexaClientSDK::avsCommon::avs::CapabilityAgentvirtual
canStateBeRetrieved()alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterfaceinlinevirtual
CapabilityAgent(const std::string &nameSpace, std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender)alexaClientSDK::avsCommon::avs::CapabilityAgentprotected
clearExecuteCommands(const aplCapabilityCommonInterfaces::PresentationToken &token=std::string(), const bool markAsFailed=true) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
createDirectiveInfo(std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result)alexaClientSDK::avsCommon::avs::CapabilityAgentprotectedvirtual
DirectiveType enum namealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotected
doShutdown() overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
getAPLCapabilityConfigurations(const std::string &APLMaxVersion)=0alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotectedpure virtual
getAPLDirectiveConfiguration() const =0alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotectedpure virtual
getCapabilityConfigurations() overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
getConfiguration() const overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
getConfigurationRootKey()=0alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotectedpure virtual
getDirectiveType(std::shared_ptr< DirectiveInfo > info)=0alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotectedpure virtual
getExecutor()alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotected
getMetricActivityName(MetricActivity activity)=0alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotectedpure virtual
getMetricDataPointName(MetricEvent event)=0alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotectedpure virtual
getPresentationSessionFieldNames()=0alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotectedpure virtual
handleDirective(std::shared_ptr< DirectiveInfo > info) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
alexaClientSDK::avsCommon::avs::CapabilityAgent::handleDirective(const std::string &messageId) override finalalexaClientSDK::avsCommon::avs::CapabilityAgentvirtual
handleDirectiveImmediately(std::shared_ptr< alexaClientSDK::avsCommon::avs::AVSDirective > directive) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgent
alexaClientSDK::avsCommon::avs::CapabilityAgent::handleDirectiveImmediately(std::shared_ptr< avsCommon::avs::AVSDirective > directive)=0alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterfacepure virtual
handleUnknownDirective(std::shared_ptr< DirectiveInfo > info)alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotected
hasReportableStateProperties()alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterfaceinlinevirtual
initialize()alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
isShutdown() constalexaClientSDK::avsCommon::utils::RequiresShutdown
m_exceptionEncounteredSenderalexaClientSDK::avsCommon::avs::CapabilityAgentprotected
m_namespacealexaClientSDK::avsCommon::avs::CapabilityAgentprotected
MetricActivity enum namealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotected
MetricEvent enum namealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotected
name() constalexaClientSDK::avsCommon::utils::RequiresShutdown
Notifier()alexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >inline
notifyObservers(std::function< void(const std::shared_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface > &)> notify) overridealexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >inlinevirtual
notifyObserversInReverse(std::function< void(const std::shared_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface > &)> notify) overridealexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >inlinevirtual
onActiveDocumentChanged(const aplCapabilityCommonInterfaces::PresentationToken &token, const alexaClientSDK::aplCapabilityCommonInterfaces::PresentationSession &session) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
onContextAvailable(const std::string &jsonContext) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
alexaClientSDK::avsCommon::avs::CapabilityAgent::onContextAvailable(const endpoints::EndpointIdentifier &endpointId, const avs::AVSContext &endpointContext, ContextRequestToken requestToken)alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterfaceinlinevirtual
onContextFailure(const alexaClientSDK::avsCommon::sdkInterfaces::ContextRequestError error) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
alexaClientSDK::avsCommon::avs::CapabilityAgent::onContextFailure(const ContextRequestError error, ContextRequestToken token)alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterfaceinlinevirtual
onDeregistered() overridealexaClientSDK::avsCommon::avs::CapabilityAgentvirtual
onFocusChanged(FocusState newFocus, MixingBehavior behavior) overridealexaClientSDK::avsCommon::avs::CapabilityAgentvirtual
onVisualContextAvailable(avsCommon::sdkInterfaces::ContextRequestToken requestToken, const aplCapabilityCommonInterfaces::aplEventPayload::VisualContext &context) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
preHandleDirective(std::shared_ptr< DirectiveInfo > info) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
alexaClientSDK::avsCommon::avs::CapabilityAgent::preHandleDirective(std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result) override finalalexaClientSDK::avsCommon::avs::CapabilityAgent
alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface::preHandleDirective(std::shared_ptr< avsCommon::avs::AVSDirective > directive, std::unique_ptr< DirectiveHandlerResultInterface > result)=0alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterfacepure virtual
proactiveStateReport() overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
processExecuteCommandsResult(const aplCapabilityCommonInterfaces::PresentationToken &token, aplCapabilityCommonInterfaces::APLCommandExecutionEvent event, const std::string &error) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
processRenderDocumentResult(const aplCapabilityCommonInterfaces::PresentationToken &token, const bool result, const std::string &error) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
provideState(const alexaClientSDK::avsCommon::avs::NamespaceAndName &stateProviderName, unsigned int stateRequestToken) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
alexaClientSDK::avsCommon::avs::CapabilityAgent::provideState(const avs::CapabilityTag &stateProviderName, const ContextRequestToken stateRequestToken)alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterfaceinlinevirtual
recordRenderComplete(const std::chrono::steady_clock::time_point &timestamp) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
alexaClientSDK::avsCommon::avs::CapabilityAgent::removeDirective(const std::string &messageId)alexaClientSDK::avsCommon::avs::CapabilityAgentprotected
removeObserver(const std::shared_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface > &observer) overridealexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >inlinevirtual
removeWeakPtrObserver(const std::weak_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface > &observer) overridealexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >inlinevirtual
RequiresShutdown(const std::string &name)alexaClientSDK::avsCommon::utils::RequiresShutdown
sendDataSourceFetchRequestEvent(const aplCapabilityCommonInterfaces::aplEventPayload::DataSourceFetch &fetchPayload) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
sendExceptionEncounteredAndReportFailed(std::shared_ptr< DirectiveInfo > info, const std::string &message, avsCommon::avs::ExceptionErrorType type=avsCommon::avs::ExceptionErrorType::INTERNAL_ERROR)alexaClientSDK::avsCommon::avs::CapabilityAgentprotected
sendRuntimeErrorEvent(const aplCapabilityCommonInterfaces::aplEventPayload::RuntimeError &errors) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
sendUserEvent(const aplCapabilityCommonInterfaces::aplEventPayload::UserEvent &eventPayload) overridealexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
setAddObserverFunction(std::function< void(const std::shared_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface > &)> addObserverFunc) overridealexaClientSDK::notifier::Notifier< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >inlinevirtual
setExecutor(const std::shared_ptr< alexaClientSDK::avsCommon::utils::threading::Executor > &executor)alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgent
setHandlingCompleted(std::shared_ptr< DirectiveInfo > info)alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotected
shouldPackPresentationSessionToAvsEvents()=0alexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentprotectedpure virtual
shouldQueryState()alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterfaceinlinevirtual
shutdown()alexaClientSDK::avsCommon::utils::RequiresShutdown
~APLCapabilityAgentInterface()=defaultalexaClientSDK::aplCapabilityCommonInterfaces::APLCapabilityAgentInterfacevirtual
~BaseAPLCapabilityAgent()=defaultalexaClientSDK::aplCapabilityCommon::BaseAPLCapabilityAgentvirtual
~CapabilityAgent()=defaultalexaClientSDK::avsCommon::avs::CapabilityAgentvirtual
~CapabilityConfigurationInterface()=defaultalexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterfacevirtual
~ChannelObserverInterface()=defaultalexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterfacevirtual
~ContextRequesterInterface()=defaultalexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterfacevirtual
~DirectiveHandlerInterface()=defaultalexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterfacevirtual
~NotifierInterface()=defaultalexaClientSDK::notifierInterfaces::NotifierInterface< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >virtual
~RequiresShutdown()alexaClientSDK::avsCommon::utils::RequiresShutdownvirtual
~StateProviderInterface()=defaultalexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterfacevirtual

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