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

#include <PresentationInterface.h>

Public Member Functions

virtual ~PresentationInterface ()=default
 
virtual void dismiss ()=0
 
virtual void foreground ()=0
 
virtual void setMetadata (const std::string &metadata)=0
 
virtual void setLifespan (const PresentationLifespan &lifespan)=0
 
virtual void startTimeout ()=0
 
virtual void stopTimeout ()=0
 
virtual void setTimeout (const std::chrono::milliseconds &timeout)=0
 
virtual PresentationState getState ()=0
 

Static Public Member Functions

static const std::chrono::milliseconds getTimeoutDisabled ()
 
static const std::chrono::milliseconds getTimeoutDefault ()
 

Detailed Description

Interface which represents a Presentation object, provides methods to manage the lifecycle of a presentation

Constructor & Destructor Documentation

◆ ~PresentationInterface()

virtual alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::~PresentationInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ dismiss()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::dismiss ( )
pure virtual

Dismiss the current presentation

◆ foreground()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::foreground ( )
pure virtual

Request foregrounding of the current presentation

◆ getState()

virtual PresentationState alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::getState ( )
pure virtual

Gets the current state for this presentation

Returns
The current presentation state

◆ getTimeoutDefault()

static const std::chrono::milliseconds alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::getTimeoutDefault ( )
inlinestatic

Gets a value which can be used in setTimeout that indicates the timeout should be set to the default value associated with the PresentationLifespan for the presentation.

Returns
Value indicating default timeout should be used

◆ getTimeoutDisabled()

static const std::chrono::milliseconds alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::getTimeoutDisabled ( )
inlinestatic

Gets a value which can be used in setTimeout that indicates the timeout should be disabled.

Returns
Value indicating timeout is disabled

◆ setLifespan()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::setLifespan ( const PresentationLifespan lifespan)
pure virtual

Sets the lifespan of the presentation

Parameters
lifespannew lifespan value

◆ setMetadata()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::setMetadata ( const std::string &  metadata)
pure virtual

Sets the metadata associated with this presentation

Parameters
tokenThe new metadata

◆ setTimeout()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::setTimeout ( const std::chrono::milliseconds &  timeout)
pure virtual

Sets the timeout for this presentation - the new value will take effect the next time the timeout is restarted

Parameters
timeoutThe new timeout value, use PresentationInterface::getTimeoutDisabled() to disable the timeout use PresentationInterface::getTimeoutDefault() to default timeout based on the presentation lifespan

◆ startTimeout()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::startTimeout ( )
pure virtual

Starts or Restarts the timeout for this presentation.

Note
the timer will only be started if the presentation currently is focused, i.e. is in the FOREGROUND state

◆ stopTimeout()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::stopTimeout ( )
pure virtual

Stops the timeout for this presentation

Note
the timer may be resumed as a result of other user actions, or presentation state change events.

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