AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Enumerations
alexaClientSDK::acsdkAlexaPresentationInterfaces Namespace Reference

Classes

class  APLDocumentObserverInterface
 
class  APLDocumentSessionInterface
 
class  APLRuntimeInterface
 
struct  AutoInitializedExtension
 
struct  GrantedExtension
 
struct  PresentationOptions
 
struct  PresentationSession
 

Enumerations

enum  VisualFocusBehavior { VisualFocusBehavior::MAY_BACKGROUND, VisualFocusBehavior::MUST_DISMISS, VisualFocusBehavior::ALWAYS_FOREGROUND }
 
enum  PresentationLifespan { PresentationLifespan::TRANSIENT, PresentationLifespan::SHORT, PresentationLifespan::LONG, PresentationLifespan::PERMANENT }
 

Enumeration Type Documentation

◆ PresentationLifespan

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.

◆ VisualFocusBehavior

Enumerator
MAY_BACKGROUND 

The content can be backgrounded, if another presentation takes the window.

MUST_DISMISS 

The content cannot be backgrounded, if another presentation takes focus this presentation must be dismissed

ALWAYS_FOREGROUND 

The content is on top at all times, other presentations cannot take focus.

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0