ask_sdk_model.interfaces.alexa.presentation.html 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.html.alexa_presentation_html_interface module

class ask_sdk_model.interfaces.alexa.presentation.html.alexa_presentation_html_interface.AlexaPresentationHtmlInterface(runtime=None)

Bases: object

Parameters:runtime ((optional) ask_sdk_model.interfaces.alexa.presentation.html.runtime.Runtime) –

attribute_map = {'runtime': 'runtime'}

deserialized_types = {'runtime': 'ask_sdk_model.interfaces.alexa.presentation.html.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.html.configuration module

class ask_sdk_model.interfaces.alexa.presentation.html.configuration.Configuration(timeout_in_seconds=None)

Bases: object

Parameters:timeout_in_seconds ((optional) int) – The number of seconds the content can stay on the screen without user interaction. Default value is 30 seconds. Maximum allowed value is 5 minutes.

attribute_map = {'timeout_in_seconds': 'timeoutInSeconds'}

deserialized_types = {'timeout_in_seconds': 'int'}

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.html.handle_message_directive module

class ask_sdk_model.interfaces.alexa.presentation.html.handle_message_directive.HandleMessageDirective(message=None, transformers=None)

Bases: ask_sdk_model.directive.Directive

The HandleMessage directive sends a message to a skill's web application that runs on the device browser. To use this directive, [apply to participate](https://build.amazonalexadev.com/AlexaWebAPIforGamesDeveloperPreview_AlexaWebAPIforGames.html) in the Alexa Web API for Games developer preview.

Parameters:

• message ((optional) object) – A free-form object containing data to deliver to a skill's HTML application running the device. Maximum size 18 KB.
• transformers ((optional) list[ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer]) – An array of objects for performing text-to-speech transformations with message data

attribute_map = {'message': 'message', 'object_type': 'type', 'transformers': 'transformers'}

deserialized_types = {'message': 'object', 'object_type': 'str', 'transformers': 'list[ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer]'}

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.html.message_request module

class ask_sdk_model.interfaces.alexa.presentation.html.message_request.MessageRequest(request_id=None, timestamp=None, locale=None, message=None)

Bases: ask_sdk_model.request.Request

The Message request sends a message to the skill lambda. To use this request, [apply to participate](https://build.amazonalexadev.com/AlexaWebAPIforGamesDeveloperPreview_AlexaWebAPIforGames.html) in the Alexa Web API for Games developer preview.

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.
• message ((optional) object) – A free-form object containing data from a skill's HTML application to deliver to the Alexa cloud. Maximum size 18 KB.

attribute_map = {'locale': 'locale', 'message': 'message', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'locale': 'str', 'message': 'object', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

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.html.runtime module

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

Bases: object

Contains the runtime information for the interface.

Parameters:max_version ((optional) str) – The max version of the HTML runtime supported by the device.

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.html.start_directive module

class ask_sdk_model.interfaces.alexa.presentation.html.start_directive.StartDirective(data=None, transformers=None, request=None, configuration=None)

Bases: ask_sdk_model.directive.Directive

The Start directive provides the data necessary to load an HTML page on the target device. To use this directive, [apply to participate](https://build.amazonalexadev.com/AlexaWebAPIforGamesDeveloperPreview_AlexaWebAPIforGames.html) in the Alexa Web API for Games developer preview.

Parameters:

• data ((optional) object) – Optional startup data which will be made available to the runtime for skill startup. Maximum size: 18 KB
• transformers ((optional) list[ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer]) – An array of objects for performing text-to-speech transformations with message data
• request ((optional) ask_sdk_model.interfaces.alexa.presentation.html.start_request.StartRequest) –
• configuration ((optional) ask_sdk_model.interfaces.alexa.presentation.html.configuration.Configuration) –

attribute_map = {'configuration': 'configuration', 'data': 'data', 'object_type': 'type', 'request': 'request', 'transformers': 'transformers'}

deserialized_types = {'configuration': 'ask_sdk_model.interfaces.alexa.presentation.html.configuration.Configuration', 'data': 'object', 'object_type': 'str', 'request': 'ask_sdk_model.interfaces.alexa.presentation.html.start_request.StartRequest', 'transformers': 'list[ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer]'}

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.html.start_request module

class ask_sdk_model.interfaces.alexa.presentation.html.start_request.StartRequest(method=None, uri=None, headers=None)

Bases: object

Parameters:

• method ((optional) ask_sdk_model.interfaces.alexa.presentation.html.start_request_method.StartRequestMethod) –
• uri ((optional) str) – HTTPS URI of the HTML page to load. This URI must abide by the [URI RFC 3986](https://tools.ietf.org/html/rfc3986). The HTML runtime must perform secure requests, using the HTTPS schema. Maximum size 8000 characters
• headers ((optional) object) – HTTP headers that the HTML runtime requires to access resources. Only the Authorization header and custom headers are allowed

attribute_map = {'headers': 'headers', 'method': 'method', 'uri': 'uri'}

deserialized_types = {'headers': 'object', 'method': 'ask_sdk_model.interfaces.alexa.presentation.html.start_request_method.StartRequestMethod', 'uri': '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.html.start_request_method module

class ask_sdk_model.interfaces.alexa.presentation.html.start_request_method.StartRequestMethod

Bases: enum.Enum

Allowed enum values: [GET]

GET = 'GET'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.alexa.presentation.html.transformer module

class ask_sdk_model.interfaces.alexa.presentation.html.transformer.Transformer(transformer=None, input_path=None, output_name=None)

Bases: object

Properties for performing text to speech transformations. These are the same properties that [APL transformers](https://developer.amazon.com/docs/alexa-presentation-language/apl-data-source.html#transformer-properties-and-conversion-rules) use.

Parameters:

• transformer ((optional) ask_sdk_model.interfaces.alexa.presentation.html.transformer_type.TransformerType) –
• input_path ((optional) str) – A JSON path that points to either a single entity in the message object, or a set of entities using wildcard or unresolved arrays. Examples 'family[*].name', 'address.street'. See [APL transformer properties](https://developer.amazon.com/docs/alexa-presentation-language/apl-data-source.html#transformer-properties-and-conversion-rules) for more details.
• output_name ((optional) str) – Name of the output property to add to the message object. For example, if the inputPath is "address.street", the transformer output will be stored at "address.outputName". If no outputName is supplied, the transformer output will override the value at inputPath.

attribute_map = {'input_path': 'inputPath', 'output_name': 'outputName', 'transformer': 'transformer'}

deserialized_types = {'input_path': 'str', 'output_name': 'str', 'transformer': 'ask_sdk_model.interfaces.alexa.presentation.html.transformer_type.TransformerType'}

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.html.transformer_type module

class ask_sdk_model.interfaces.alexa.presentation.html.transformer_type.TransformerType

Bases: enum.Enum

Allowed enum values: [ssmlToSpeech, textToSpeech, textToHint, ssmlToText]

ssmlToSpeech = 'ssmlToSpeech'

ssmlToText = 'ssmlToText'

textToHint = 'textToHint'

textToSpeech = 'textToSpeech'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model