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::test::MockAPLDocumentObserver Class Reference

#include <MockAPLDocumentObserver.h>

Inheritance diagram for alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver:
Collaboration graph
[legend]

Public Member Functions

 MOCK_METHOD3 (onAPLDocumentSessionAvailableTest, void(const PresentationSession &presentationSession, const PresentationToken &token, APLDocumentSessionInterface *session))
 
void onAPLDocumentSessionAvailable (const PresentationSession &presentationSession, const PresentationToken &token, std::unique_ptr< APLDocumentSessionInterface > &&session)
 
 MOCK_METHOD1 (onDocumentFinished, void(const PresentationToken &token))
 
 MOCK_METHOD2 (onActiveDocumentChanged, void(const PresentationToken &token, const alexaClientSDK::aplCapabilityCommonInterfaces::PresentationSession &session))
 
 MOCK_METHOD4 (onRenderDocumentComplete, void(const PresentationToken &token, bool result, const std::string &error, const std::chrono::steady_clock::time_point &timestamp))
 
 MOCK_METHOD3 (onCommandExecutionComplete, void(const PresentationToken &token, APLCommandExecutionEvent result, const std::string &error))
 
 MOCK_METHOD3 (onDataSourceUpdateComplete, void(const PresentationToken &token, bool result, const std::string &error))
 
 MOCK_METHOD2 (onVisualContextAvailable, void(const avsCommon::sdkInterfaces::ContextRequestToken requestToken, const aplEventPayload::VisualContext &context))
 
 MOCK_METHOD1 (onDataSourceFetch, void(const aplEventPayload::DataSourceFetch &payload))
 
 MOCK_METHOD1 (onRuntimeError, void(const aplEventPayload::RuntimeError &payload))
 
 MOCK_METHOD1 (onSessionEnded, void(const alexaClientSDK::aplCapabilityCommonInterfaces::PresentationSession &presentationSession))
 
 MOCK_METHOD2 (onActivityEvent, void(const PresentationToken &token, const avsCommon::sdkInterfaces::GUIActivityEvent &event))
 
- Public Member Functions inherited from alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface
virtual ~APLDocumentObserverInterface ()=default
 
virtual void onDocumentFinished (const PresentationToken &token)=0
 
virtual void onActiveDocumentChanged (const PresentationToken &token, const PresentationSession &session)=0
 
virtual void onRenderDocumentComplete (const PresentationToken &token, bool result, const std::string &error, const std::chrono::steady_clock::time_point &timestamp)=0
 
virtual void onCommandExecutionComplete (const PresentationToken &token, APLCommandExecutionEvent result, const std::string &error)=0
 
virtual void onDataSourceUpdateComplete (const PresentationToken &token, bool result, const std::string &error)=0
 
virtual void onSendEvent (const aplEventPayload::UserEvent &payload)=0
 
virtual void onVisualContextAvailable (const avsCommon::sdkInterfaces::ContextRequestToken requestToken, const aplEventPayload::VisualContext &context)=0
 
virtual void onDataSourceFetch (const aplEventPayload::DataSourceFetch &payload)=0
 
virtual void onRuntimeError (const aplEventPayload::RuntimeError &payload)=0
 
virtual void onSessionEnded (const PresentationSession &presentationSession)=0
 
virtual void onActivityEvent (const PresentationToken &token, const avsCommon::sdkInterfaces::GUIActivityEvent &event)=0
 

Detailed Description

Mock class that implements APLDocumentObserverInterface

Member Function Documentation

◆ MOCK_METHOD1() [1/4]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD1 ( onDocumentFinished  ,
void(const PresentationToken &token)   
)

◆ MOCK_METHOD1() [2/4]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD1 ( onDataSourceFetch  ,
void(const aplEventPayload::DataSourceFetch &payload)   
)

◆ MOCK_METHOD1() [3/4]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD1 ( onRuntimeError  ,
void(const aplEventPayload::RuntimeError &payload)   
)

◆ MOCK_METHOD1() [4/4]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD1 ( onSessionEnded  ,
void(const alexaClientSDK::aplCapabilityCommonInterfaces::PresentationSession &presentationSession)   
)

◆ MOCK_METHOD2() [1/3]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD2 ( onActiveDocumentChanged  ,
void(const PresentationToken &token, const alexaClientSDK::aplCapabilityCommonInterfaces::PresentationSession &session)   
)

◆ MOCK_METHOD2() [2/3]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD2 ( onVisualContextAvailable  ,
void(const avsCommon::sdkInterfaces::ContextRequestToken requestToken, const aplEventPayload::VisualContext &context)   
)

◆ MOCK_METHOD2() [3/3]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD2 ( onActivityEvent  ,
void(const PresentationToken &token, const avsCommon::sdkInterfaces::GUIActivityEvent &event)   
)

◆ MOCK_METHOD3() [1/3]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD3 ( onAPLDocumentSessionAvailableTest  ,
void(const PresentationSession &presentationSession, const PresentationToken &token, APLDocumentSessionInterface *session)   
)

◆ MOCK_METHOD3() [2/3]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD3 ( onCommandExecutionComplete  ,
void(const PresentationToken &token, APLCommandExecutionEvent result, const std::string &error)   
)

◆ MOCK_METHOD3() [3/3]

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD3 ( onDataSourceUpdateComplete  ,
void(const PresentationToken &token, bool result, const std::string &error)   
)

◆ MOCK_METHOD4()

alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::MOCK_METHOD4 ( onRenderDocumentComplete  ,
void(const PresentationToken &token, bool result, const std::string &error, const std::chrono::steady_clock::time_point &timestamp)   
)

◆ onAPLDocumentSessionAvailable()

void alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver::onAPLDocumentSessionAvailable ( const PresentationSession presentationSession,
const PresentationToken token,
std::unique_ptr< APLDocumentSessionInterface > &&  session 
)
inlinevirtual

Callback when document session is available. Session may be stored to further influence the document being rendered.

Parameters
presentationSessionThe presentation session associated with this document session
tokenpresentationToken of document session available
sessionDocumentSession object

Implements alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface.


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