alexaClientSDK::presentationOrchestratorInterfaces Namespace Reference

Namespaces
	test

Classes
class	PresentationInterface
struct	PresentationMetadata
class	PresentationObserverInterface
struct	PresentationOptions
class	PresentationOrchestratorClientInterface
class	PresentationOrchestratorInterface
class	PresentationOrchestratorStateObserverInterface
class	PresentationOrchestratorStateTrackerInterface
struct	PresentationOrchestratorWindowInfo
struct	PresentationOrchestratorWindowInstance
class	PresentationOrchestratorWindowObserverInterface
class	VisualTimeoutManagerInterface

Typedefs
using	PresentationRequestToken = uint64_t

Enumerations
enum	PresentationLifespan { PresentationLifespan::TRANSIENT, PresentationLifespan::SHORT, PresentationLifespan::LONG, PresentationLifespan::PERMANENT }
enum	PresentationState { PresentationState::FOREGROUND, PresentationState::FOREGROUND_UNFOCUSED, PresentationState::BACKGROUND, PresentationState::NONE }

Functions
std::string	presentationStateToString (PresentationState state)
std::ostream &	operator<< (std::ostream &stream, const PresentationState &state)
std::string	presentationLifespanToString (PresentationLifespan lifespan)
std::ostream &	operator<< (std::ostream &stream, const PresentationLifespan &lifespan)

Typedef Documentation

PresentationRequestToken

using alexaClientSDK::presentationOrchestratorInterfaces::PresentationRequestToken = typedef uint64_t

Enumeration Type Documentation

PresentationLifespan

enum alexaClientSDK::presentationOrchestratorInterfaces::PresentationLifespan

strong

Enumerator
TRANSIENT	A short lived presentation which cannot be backgrounded, upon timeout will be dismissed and the next SHORT, LONG or PERMANENT presentation will be resumed
SHORT	A short lived presentation, not generally backgrounded but can be if a transient presentation is displayed. Upon timeout the next LONG or PERMANENT presentation will be resumed
LONG	A long lived presentation, may not have a timeout attached to it - will be backgrounded if another presentation is displayed
PERMANENT	Special use case for applications that are always running and are not expected to terminate, for example home screens. Permanent presentations can be backgrounded but cannot be dismissed as a result of back navigation.

PresentationState

enum alexaClientSDK::presentationOrchestratorInterfaces::PresentationState

strong

enumeration of all PresentationStates

Enumerator
FOREGROUND	Presentation is in the foreground of its window and has focus (it is the primary target of user interaction)
FOREGROUND_UNFOCUSED	Presentation is in the foreground of the window, but is not the focused application
BACKGROUND	Presentation is no longer in the foreground and does not have focus
NONE	Presentation has been dismissed

Function Documentation

operator<<() [1/2]

std::ostream& alexaClientSDK::presentationOrchestratorInterfaces::operator<< ( std::ostream &  stream, const PresentationState &  state  )

inline

Write a PresentationState value to an ostream as a string.

Parameters

stream	The stream to write the value to.
state	The PresentationState value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [2/2]

std::ostream& alexaClientSDK::presentationOrchestratorInterfaces::operator<< ( std::ostream &  stream, const PresentationLifespan &  lifespan  )

inline

Write a PresentationLifespan value to an ostream as a string.

Parameters

stream	The stream to write the value to.
lifespan	The PresentationLifespan value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

presentationLifespanToString()

std::string alexaClientSDK::presentationOrchestratorInterfaces::presentationLifespanToString ( PresentationLifespan  lifespan )

inline

This function converts the provided PresentationLifespan to a string.

Parameters

state

The PresentationLifespan to convert to a string.

Returns

The string conversion of lifespan.

presentationStateToString()

std::string alexaClientSDK::presentationOrchestratorInterfaces::presentationStateToString ( PresentationState  state )

inline

This function converts the provided PresentationState to a string.

Parameters

state

The PresentationState to convert to a string.

Returns

The string conversion of state.