AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface Class Referenceabstract

#include <VisualStateProviderInterface.h>

Inheritance diagram for alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface:
Inheritance graph

Public Member Functions

virtual ~VisualStateProviderInterface ()=default
virtual void provideState (const PresentationToken &token, const avsCommon::sdkInterfaces::ContextRequestToken stateRequestToken)=0

Detailed Description

A VisualStateProviderInterface may be any client component that provides updates on the visual context of the device.

Constructor & Destructor Documentation

◆ ~VisualStateProviderInterface()

virtual alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface::~VisualStateProviderInterface ( )


Member Function Documentation

◆ provideState()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface::provideState ( const PresentationToken token,
const avsCommon::sdkInterfaces::ContextRequestToken  stateRequestToken 
pure virtual

A request to a VisualStateProvider to provide the state. The requester specifies a token which the VisualStateProvider must use when it updates the state via the onVisualContextAvailable call to APL Capability Agent.

tokenThe token of the last displaying document to get the correct context in the onVisualContextAvailable call.
stateRequestTokenThe token to use in the onVisualContextAvailable call.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge, and alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

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

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