ask_sdk_model.interfaces.alexa.presentation.aplt package

Submodules

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_sdk_model.interfaces.alexa.presentation.aplt.alexa_presentation_aplt_interface module

class ask_sdk_model.interfaces.alexa.presentation.aplt.alexa_presentation_aplt_interface.AlexaPresentationApltInterface(runtime=None)

Bases: object

Parameters:runtime ((optional) ask_sdk_model.interfaces.alexa.presentation.aplt.runtime.Runtime) –
attribute_map = {'runtime': 'runtime'}
deserialized_types = {'runtime': 'ask_sdk_model.interfaces.alexa.presentation.aplt.runtime.Runtime'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.auto_page_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.auto_page_command.AutoPageCommand(delay=None, description=None, screen_lock=None, when=None, component_id=None, count=None, duration=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Automatically progress through a series of pages displayed in a Pager component. The AutoPage command finishes after the last page has been displayed for the requested time period.

Parameters:
  • delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
  • description ((optional) str) – A user-provided description of this command.
  • screen_lock ((optional) bool) – If true, disable the Interaction Timer.
  • when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
  • component_id ((optional) str) – The id of the Pager component.
  • count ((optional) int) – Number of pages to display. Defaults to all of them.
  • duration ((optional) int) – Time to wait between pages (in milliseconds). Defaults to 0.
attribute_map = {'component_id': 'componentId', 'count': 'count', 'delay': 'delay', 'description': 'description', 'duration': 'duration', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}
deserialized_types = {'component_id': 'str', 'count': 'int', 'delay': 'int', 'description': 'str', 'duration': 'int', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command(object_type=None, delay=None, description=None, screen_lock=None, when=None)

Bases: object

A message that can change the visual or audio presentation of the content on the screen.

Parameters:
  • object_type ((optional) str) – Defines the command type and dictates which properties must/can be included.
  • delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
  • description ((optional) str) – A user-provided description of this command.
  • screen_lock ((optional) bool) – If true, disable the Interaction Timer.
  • when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets type variable.

SetValue: ask_sdk_model.interfaces.alexa.presentation.aplt.set_value_command.SetValueCommand,

Idle: ask_sdk_model.interfaces.alexa.presentation.aplt.idle_command.IdleCommand,

AutoPage: ask_sdk_model.interfaces.alexa.presentation.aplt.auto_page_command.AutoPageCommand,

Scroll: ask_sdk_model.interfaces.alexa.presentation.aplt.scroll_command.ScrollCommand,

SendEvent: ask_sdk_model.interfaces.alexa.presentation.aplt.send_event_command.SendEventCommand,

Parallel: ask_sdk_model.interfaces.alexa.presentation.aplt.parallel_command.ParallelCommand,

SetPage: ask_sdk_model.interfaces.alexa.presentation.aplt.set_page_command.SetPageCommand,

Sequential: ask_sdk_model.interfaces.alexa.presentation.aplt.sequential_command.SequentialCommand
attribute_map = {'delay': 'delay', 'description': 'description', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}
deserialized_types = {'delay': 'int', 'description': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}
discriminator_value_class_map = {'AutoPage': 'ask_sdk_model.interfaces.alexa.presentation.aplt.auto_page_command.AutoPageCommand', 'Idle': 'ask_sdk_model.interfaces.alexa.presentation.aplt.idle_command.IdleCommand', 'Parallel': 'ask_sdk_model.interfaces.alexa.presentation.aplt.parallel_command.ParallelCommand', 'Scroll': 'ask_sdk_model.interfaces.alexa.presentation.aplt.scroll_command.ScrollCommand', 'SendEvent': 'ask_sdk_model.interfaces.alexa.presentation.aplt.send_event_command.SendEventCommand', 'Sequential': 'ask_sdk_model.interfaces.alexa.presentation.aplt.sequential_command.SequentialCommand', 'SetPage': 'ask_sdk_model.interfaces.alexa.presentation.aplt.set_page_command.SetPageCommand', 'SetValue': 'ask_sdk_model.interfaces.alexa.presentation.aplt.set_value_command.SetValueCommand'}
classmethod get_real_child_model(data)

Returns the real base class specified by the discriminator

json_discriminator_key = 'type'
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.execute_commands_directive module

class ask_sdk_model.interfaces.alexa.presentation.aplt.execute_commands_directive.ExecuteCommandsDirective(commands=None, token=None)

Bases: ask_sdk_model.directive.Directive

Alexa.Presentation.APLT.ExecuteCommands directive used to send APL-T commands to a device.

Parameters:
attribute_map = {'commands': 'commands', 'object_type': 'type', 'token': 'token'}
deserialized_types = {'commands': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'object_type': 'str', 'token': 'str'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.idle_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.idle_command.IdleCommand(delay=None, description=None, screen_lock=None, when=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

The idle command does nothing. It may be a placeholder or used to insert a calculated delay in a longer series of commands.

Parameters:
  • delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
  • description ((optional) str) – A user-provided description of this command.
  • screen_lock ((optional) bool) – If true, disable the Interaction Timer.
  • when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
attribute_map = {'delay': 'delay', 'description': 'description', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}
deserialized_types = {'delay': 'int', 'description': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.parallel_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.parallel_command.ParallelCommand(delay=None, description=None, screen_lock=None, when=None, commands=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Execute a series of commands in parallel. The parallel command starts executing all child command simultaneously. The parallel command is considered finished when all of its child commands have finished. When the parallel command is terminated early, all currently executing commands are terminated.

Parameters:
  • delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
  • description ((optional) str) – A user-provided description of this command.
  • screen_lock ((optional) bool) – If true, disable the Interaction Timer.
  • when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
  • commands ((optional) list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]) – An un-ordered array of commands to execute in parallel. Once all commands have finished executing the parallel command finishes. Please note that the delay of parallel command and the delay of each command are additive.
attribute_map = {'commands': 'commands', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}
deserialized_types = {'commands': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.position module

class ask_sdk_model.interfaces.alexa.presentation.aplt.position.Position

Bases: enum.Enum

Whether the value is a relative or absolute offset. Defaults to absolute.

Allowed enum values: [absolute, relative]

absolute = 'absolute'
relative = 'relative'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.render_document_directive module

class ask_sdk_model.interfaces.alexa.presentation.aplt.render_document_directive.RenderDocumentDirective(token=None, target_profile=None, document=None, datasources=None)

Bases: ask_sdk_model.directive.Directive

Parameters:
  • token ((optional) str) – A unique identifier for the presentation.
  • target_profile ((optional) ask_sdk_model.interfaces.alexa.presentation.aplt.target_profile.TargetProfile) – One of supported profiles in character display. Default value is NONE.
  • document ((optional) dict(str, object)) – Depending on the document type, it represents either an entire APLT document or a reference Link to the document. In a Link object, the value of the 'src' should follow a URI format defined like 'doc://alexa/aplt/documents/<document_id>'. The 'document_id' is a reference to the APLT document that the developer stores through APL Authoring Tool.
  • datasources ((optional) dict(str, object)) – Data sources to bind to the document when rendering.
attribute_map = {'datasources': 'datasources', 'document': 'document', 'object_type': 'type', 'target_profile': 'targetProfile', 'token': 'token'}
deserialized_types = {'datasources': 'dict(str, object)', 'document': 'dict(str, object)', 'object_type': 'str', 'target_profile': 'ask_sdk_model.interfaces.alexa.presentation.aplt.target_profile.TargetProfile', 'token': 'str'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.runtime module

class ask_sdk_model.interfaces.alexa.presentation.aplt.runtime.Runtime(max_version=None)

Bases: object

Contains the runtime information for the interface.

Parameters:max_version ((optional) str) – Maximum APL-T version supported by the runtime.
attribute_map = {'max_version': 'maxVersion'}
deserialized_types = {'max_version': 'str'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.scroll_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.scroll_command.ScrollCommand(delay=None, description=None, screen_lock=None, when=None, distance=None, component_id=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Scroll a ScrollView or Sequence forward or backward by a number of pages. The Scroll command has the following properties in addition to the regular command properties.

Parameters:
  • delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
  • description ((optional) str) – A user-provided description of this command.
  • screen_lock ((optional) bool) – If true, disable the Interaction Timer.
  • when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
  • distance ((optional) int) – The number of pages to scroll. Defaults to 1.
  • component_id ((optional) str) – The id of the component.
attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'distance': 'distance', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}
deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'distance': 'int', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.send_event_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.send_event_command.SendEventCommand(delay=None, description=None, screen_lock=None, when=None, arguments=None, components=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

The SendEvent command allows the APL author to generate and send an event to Alexa.

Parameters:
  • delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
  • description ((optional) str) – A user-provided description of this command.
  • screen_lock ((optional) bool) – If true, disable the Interaction Timer.
  • when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
  • arguments ((optional) list[str]) – An array of argument data to pass to Alexa.
  • components ((optional) list[str]) – An array of components to extract value data from and provide to Alexa.
attribute_map = {'arguments': 'arguments', 'components': 'components', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'screen_lock': 'screenLock', 'when': 'when'}
deserialized_types = {'arguments': 'list[str]', 'components': 'list[str]', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'when': 'bool'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.sequential_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.sequential_command.SequentialCommand(delay=None, description=None, screen_lock=None, when=None, catch=None, commands=None, object_finally=None, repeat_count=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

A sequential command executes a series of commands in order. The sequential command executes the command list in order, waiting for the previous command to finish before executing the next. The sequential command is finished when all of its child commands have finished. When the Sequential command is terminated early, the currently executing command is terminated and no further commands are executed.

Parameters:
  • delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
  • description ((optional) str) – A user-provided description of this command.
  • screen_lock ((optional) bool) – If true, disable the Interaction Timer.
  • when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
  • catch ((optional) list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]) – An ordered list of commands to execute if this sequence is prematurely terminated.
  • commands ((optional) list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]) – An array of commands to execute. The commands execute in order; each command must finish before the next can begin. Please note that the delay of sequential command and the delay of the first command in the sequence are additive.
  • object_finally ((optional) list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]) – An ordered list of commands to execute after the normal commands and the catch commands.
  • repeat_count ((optional) int) – The number of times to repeat this series of commands. Defaults to 0. Negative values will be ignored. Note that the delay assigned to overall sequential command only applies the first time. For example, in the sample sequential command below the first SendEvent fires at 3000 milliseconds, the second at 5000, the first SendEvent fires again at 7000 milliseconds, and so forth. {"type": "Sequential","delay": 1000,"repeatCount": 2,"commands": [{ "type": "SendEvent","delay": 2000},{"type": "SendEvent","delay": 2000}]}
attribute_map = {'catch': 'catch', 'commands': 'commands', 'delay': 'delay', 'description': 'description', 'object_finally': 'finally', 'object_type': 'type', 'repeat_count': 'repeatCount', 'screen_lock': 'screenLock', 'when': 'when'}
deserialized_types = {'catch': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'commands': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'delay': 'int', 'description': 'str', 'object_finally': 'list[ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command]', 'object_type': 'str', 'repeat_count': 'int', 'screen_lock': 'bool', 'when': 'bool'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.set_page_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.set_page_command.SetPageCommand(delay=None, description=None, screen_lock=None, when=None, component_id=None, position=None, value=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Change the page displayed in a Pager component. The SetPage command finishes when the item is fully in view.

Parameters:
  • delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
  • description ((optional) str) – A user-provided description of this command.
  • screen_lock ((optional) bool) – If true, disable the Interaction Timer.
  • when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
  • component_id ((optional) str) – The id of the Pager component.
  • position ((optional) ask_sdk_model.interfaces.alexa.presentation.aplt.position.Position) –
  • value ((optional) int) – The distance to move. May be an absolute value or a relative value.
attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_type': 'type', 'position': 'position', 'screen_lock': 'screenLock', 'value': 'value', 'when': 'when'}
deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_type': 'str', 'position': 'ask_sdk_model.interfaces.alexa.presentation.aplt.position.Position', 'screen_lock': 'bool', 'value': 'int', 'when': 'bool'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.set_value_command module

class ask_sdk_model.interfaces.alexa.presentation.aplt.set_value_command.SetValueCommand(delay=None, description=None, screen_lock=None, when=None, component_id=None, object_property=None, value=None)

Bases: ask_sdk_model.interfaces.alexa.presentation.aplt.command.Command

Change a dynamic property of a component without redrawing the screen.

Parameters:
  • delay ((optional) int) – The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
  • description ((optional) str) – A user-provided description of this command.
  • screen_lock ((optional) bool) – If true, disable the Interaction Timer.
  • when ((optional) bool) – A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
  • component_id ((optional) str) – The id of the component whose value to set.
  • object_property ((optional) str) – The name of the property to set.
  • value ((optional) str) – The property value to set.
attribute_map = {'component_id': 'componentId', 'delay': 'delay', 'description': 'description', 'object_property': 'property', 'object_type': 'type', 'screen_lock': 'screenLock', 'value': 'value', 'when': 'when'}
deserialized_types = {'component_id': 'str', 'delay': 'int', 'description': 'str', 'object_property': 'str', 'object_type': 'str', 'screen_lock': 'bool', 'value': 'str', 'when': 'bool'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.target_profile module

class ask_sdk_model.interfaces.alexa.presentation.aplt.target_profile.TargetProfile

Bases: enum.Enum

Name of a supported profile on character display.

Allowed enum values: [FOUR_CHARACTER_CLOCK, NONE]

FOUR_CHARACTER_CLOCK = 'FOUR_CHARACTER_CLOCK'
NONE = 'NONE'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.aplt.user_event module

class ask_sdk_model.interfaces.alexa.presentation.aplt.user_event.UserEvent(request_id=None, timestamp=None, locale=None, token=None, arguments=None, source=None)

Bases: ask_sdk_model.request.Request

Parameters:
  • request_id ((optional) str) – Represents the unique identifier for the specific request.
  • timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
  • locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
  • token ((optional) str) – A unique token for the active presentation.
  • arguments ((optional) list[object]) – The array of argument data to pass to Alexa.
  • source ((optional) object) – Meta-information about what caused the event to be generated.
attribute_map = {'arguments': 'arguments', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'source': 'source', 'timestamp': 'timestamp', 'token': 'token'}
deserialized_types = {'arguments': 'list[object]', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'source': 'object', 'timestamp': 'datetime', 'token': 'str'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model