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

#include <TemplateRuntimePresentationAdapterObserverInterface.h>

Inheritance diagram for alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapterObserverInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~TemplateRuntimePresentationAdapterObserverInterface ()=default
 
virtual void renderTemplateCard (const std::string &jsonPayload)=0
 
virtual void renderPlayerInfoCard (const std::string &jsonPayload, templateRuntimeInterfaces::TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo)=0
 
virtual void clearRenderTemplateCard ()=0
 
virtual void clearPlayerInfoCard ()=0
 

Detailed Description

An contract fulfilled by user interface to present the template runtime cards.

Constructor & Destructor Documentation

◆ ~TemplateRuntimePresentationAdapterObserverInterface()

virtual alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapterObserverInterface::~TemplateRuntimePresentationAdapterObserverInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ clearPlayerInfoCard()

virtual void alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapterObserverInterface::clearPlayerInfoCard ( )
pure virtual

◆ clearRenderTemplateCard()

virtual void alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapterObserverInterface::clearRenderTemplateCard ( )
pure virtual

◆ renderPlayerInfoCard()

virtual void alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapterObserverInterface::renderPlayerInfoCard ( const std::string &  jsonPayload,
templateRuntimeInterfaces::TemplateRuntimeObserverInterface::AudioPlayerInfo  audioPlayerInfo 
)
pure virtual

Used to notify when a RenderPlayerInfo presentation is ready to display. Once called, the client should render the PlayerInfo display card based on the metadata provided in the payload in structured JSON format.

Parameters
jsonPayloadThe payload of the RenderPlayerInfo directive in structured JSON format.
audioPlayerInfoInformation on the AudioPlayer.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge, and alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::TemplateRuntimeHandler.

◆ renderTemplateCard()

virtual void alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapterObserverInterface::renderTemplateCard ( const std::string &  jsonPayload)
pure virtual

Used to notify when a RenderTemplate presentation is ready to display. Once called, the client should render the Template display card based on the metadata provided in the payload in structured JSON format.

Note
The payload may contain customer sensitive information and should be used with utmost care. Failure to do so may result in exposing or mishandling of customer data.
Parameters
jsonPayloadThe payload of the RenderTemplate directive in structured JSON format.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge, and alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::TemplateRuntimeHandler.


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