alexaClientSDK::presentationOrchestratorInterfaces::PresentationObserverInterface Class Reference

#include <PresentationObserverInterface.h>

Inheritance diagram for alexaClientSDK::presentationOrchestratorInterfaces::PresentationObserverInterface:

Public Member Functions
virtual	~PresentationObserverInterface ()=default
virtual void	onPresentationAvailable (PresentationRequestToken id, std::shared_ptr< PresentationInterface > presentation)=0
virtual void	onPresentationStateChanged (PresentationRequestToken id, PresentationState newState)=0
virtual bool	onNavigateBack (PresentationRequestToken id)=0

Detailed Description

Interface to be implemented by observers interested in state changes to a PresentationInterface

Constructor & Destructor Documentation

~PresentationObserverInterface()

virtual alexaClientSDK::presentationOrchestratorInterfaces::PresentationObserverInterface::~PresentationObserverInterface ( )

virtualdefault

Destructor

Member Function Documentation

onNavigateBack()

virtual bool alexaClientSDK::presentationOrchestratorInterfaces::PresentationObserverInterface::onNavigateBack ( PresentationRequestToken  id )

pure virtual

Called by the presentation orchestrator to perform custom back navigation on a presentation if supported

Parameters

id	The identifier for the presentation, as provided when the window was initially requested

Returns

true if the observer handled back navigation, false if the presentation orchestrator should handle back

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession, alexaClientSDK::sampleApplications::ipcServerSampleApp::liveViewController::LiveViewControllerPresentationAdapter, and alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapter.

onPresentationAvailable()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationObserverInterface::onPresentationAvailable ( PresentationRequestToken  id, std::shared_ptr< PresentationInterface >  presentation  )

pure virtual

Called when the presentation is available for use

Parameters

id	The identifier for this presentation, as provided when the window was initially requested
presentation	The pointer used for presentation control

onPresentationStateChanged()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationObserverInterface::onPresentationStateChanged ( PresentationRequestToken  id, PresentationState  newState  )

pure virtual

Called when the presentation state has changed

Parameters

id	The identifier for this presentation, as provided when the window was initially requested
newState	The new presentation state

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession, alexaClientSDK::sampleApplications::ipcServerSampleApp::liveViewController::LiveViewControllerPresentationAdapter, and alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapter.

---

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

• /workplace/avs-device-sdk/shared/PresentationOrchestrator/PresentationOrchestratorInterfaces/include/acsdk/PresentationOrchestratorInterfaces/PresentationObserverInterface.h