ask_sdk_model.interfaces.display 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.display.back_button_behavior module

class ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior

Bases: enum.Enum

Allowed enum values: [HIDDEN, VISIBLE]

HIDDEN = 'HIDDEN'
VISIBLE = 'VISIBLE'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.body_template1 module

class ask_sdk_model.interfaces.display.body_template1.BodyTemplate1(token=None, back_button=None, background_image=None, title=None, text_content=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:
attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'object_type': 'type', 'text_content': 'textContent', 'title': 'title', 'token': 'token'}
deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', 'title': '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.display.body_template2 module

class ask_sdk_model.interfaces.display.body_template2.BodyTemplate2(token=None, back_button=None, background_image=None, image=None, title=None, text_content=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:
attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'image': 'image', 'object_type': 'type', 'text_content': 'textContent', 'title': 'title', 'token': 'token'}
deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', 'title': '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.display.body_template3 module

class ask_sdk_model.interfaces.display.body_template3.BodyTemplate3(token=None, back_button=None, background_image=None, image=None, title=None, text_content=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:
attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'image': 'image', 'object_type': 'type', 'text_content': 'textContent', 'title': 'title', 'token': 'token'}
deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', 'title': '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.display.body_template6 module

class ask_sdk_model.interfaces.display.body_template6.BodyTemplate6(token=None, back_button=None, background_image=None, text_content=None, image=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:
attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'image': 'image', 'object_type': 'type', 'text_content': 'textContent', 'token': 'token'}
deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', '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.display.body_template7 module

class ask_sdk_model.interfaces.display.body_template7.BodyTemplate7(token=None, back_button=None, title=None, image=None, background_image=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:
attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'image': 'image', 'object_type': 'type', 'title': 'title', 'token': 'token'}
deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'image': 'ask_sdk_model.interfaces.display.image.Image', 'object_type': 'str', 'title': '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.display.display_interface module

class ask_sdk_model.interfaces.display.display_interface.DisplayInterface(template_version=None, markup_version=None)

Bases: object

Parameters:
  • template_version ((optional) str) –
  • markup_version ((optional) str) –
attribute_map = {'markup_version': 'markupVersion', 'template_version': 'templateVersion'}
deserialized_types = {'markup_version': 'str', 'template_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.display.display_state module

class ask_sdk_model.interfaces.display.display_state.DisplayState(token=None)

Bases: object

Parameters:token ((optional) str) –
attribute_map = {'token': 'token'}
deserialized_types = {'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.display.element_selected_request module

class ask_sdk_model.interfaces.display.element_selected_request.ElementSelectedRequest(request_id=None, timestamp=None, locale=None, token=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) –
attribute_map = {'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp', 'token': 'token'}
deserialized_types = {'locale': 'str', 'object_type': 'str', 'request_id': 'str', '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

ask_sdk_model.interfaces.display.hint module

class ask_sdk_model.interfaces.display.hint.Hint(object_type=None)

Bases: object

Parameters:object_type ((optional) str) –

Note

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

PlainText: ask_sdk_model.interfaces.display.plain_text_hint.PlainTextHint
attribute_map = {'object_type': 'type'}
deserialized_types = {'object_type': 'str'}
discriminator_value_class_map = {'PlainText': 'ask_sdk_model.interfaces.display.plain_text_hint.PlainTextHint'}
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.display.hint_directive module

class ask_sdk_model.interfaces.display.hint_directive.HintDirective(hint=None)

Bases: ask_sdk_model.directive.Directive

Parameters:hint ((optional) ask_sdk_model.interfaces.display.hint.Hint) –
attribute_map = {'hint': 'hint', 'object_type': 'type'}
deserialized_types = {'hint': 'ask_sdk_model.interfaces.display.hint.Hint', 'object_type': '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.display.image module

class ask_sdk_model.interfaces.display.image.Image(content_description=None, sources=None)

Bases: object

Parameters:
attribute_map = {'content_description': 'contentDescription', 'sources': 'sources'}
deserialized_types = {'content_description': 'str', 'sources': 'list[ask_sdk_model.interfaces.display.image_instance.ImageInstance]'}
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.display.image_instance module

class ask_sdk_model.interfaces.display.image_instance.ImageInstance(url=None, size=None, width_pixels=None, height_pixels=None)

Bases: object

Parameters:
attribute_map = {'height_pixels': 'heightPixels', 'size': 'size', 'url': 'url', 'width_pixels': 'widthPixels'}
deserialized_types = {'height_pixels': 'int', 'size': 'ask_sdk_model.interfaces.display.image_size.ImageSize', 'url': 'str', 'width_pixels': '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.display.image_size module

class ask_sdk_model.interfaces.display.image_size.ImageSize

Bases: enum.Enum

Allowed enum values: [X_SMALL, SMALL, MEDIUM, LARGE, X_LARGE]

LARGE = 'LARGE'
MEDIUM = 'MEDIUM'
SMALL = 'SMALL'
X_LARGE = 'X_LARGE'
X_SMALL = 'X_SMALL'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.display.list_item module

class ask_sdk_model.interfaces.display.list_item.ListItem(token=None, image=None, text_content=None)

Bases: object

Parameters:
attribute_map = {'image': 'image', 'text_content': 'textContent', 'token': 'token'}
deserialized_types = {'image': 'ask_sdk_model.interfaces.display.image.Image', 'text_content': 'ask_sdk_model.interfaces.display.text_content.TextContent', '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.display.list_template1 module

class ask_sdk_model.interfaces.display.list_template1.ListTemplate1(token=None, back_button=None, background_image=None, title=None, list_items=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:
attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'list_items': 'listItems', 'object_type': 'type', 'title': 'title', 'token': 'token'}
deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'list_items': 'list[ask_sdk_model.interfaces.display.list_item.ListItem]', 'object_type': 'str', 'title': '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.display.list_template2 module

class ask_sdk_model.interfaces.display.list_template2.ListTemplate2(token=None, back_button=None, background_image=None, title=None, list_items=None)

Bases: ask_sdk_model.interfaces.display.template.Template

Parameters:
attribute_map = {'back_button': 'backButton', 'background_image': 'backgroundImage', 'list_items': 'listItems', 'object_type': 'type', 'title': 'title', 'token': 'token'}
deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'background_image': 'ask_sdk_model.interfaces.display.image.Image', 'list_items': 'list[ask_sdk_model.interfaces.display.list_item.ListItem]', 'object_type': 'str', 'title': '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.display.plain_text module

class ask_sdk_model.interfaces.display.plain_text.PlainText(text=None)

Bases: ask_sdk_model.interfaces.display.text_field.TextField

Parameters:text ((optional) str) –
attribute_map = {'object_type': 'type', 'text': 'text'}
deserialized_types = {'object_type': 'str', 'text': '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.display.plain_text_hint module

class ask_sdk_model.interfaces.display.plain_text_hint.PlainTextHint(text=None)

Bases: ask_sdk_model.interfaces.display.hint.Hint

Parameters:text ((optional) str) –
attribute_map = {'object_type': 'type', 'text': 'text'}
deserialized_types = {'object_type': 'str', 'text': '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.display.render_template_directive module

class ask_sdk_model.interfaces.display.render_template_directive.RenderTemplateDirective(template=None)

Bases: ask_sdk_model.directive.Directive

Parameters:template ((optional) ask_sdk_model.interfaces.display.template.Template) –
attribute_map = {'object_type': 'type', 'template': 'template'}
deserialized_types = {'object_type': 'str', 'template': 'ask_sdk_model.interfaces.display.template.Template'}
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.display.rich_text module

class ask_sdk_model.interfaces.display.rich_text.RichText(text=None)

Bases: ask_sdk_model.interfaces.display.text_field.TextField

Parameters:text ((optional) str) –
attribute_map = {'object_type': 'type', 'text': 'text'}
deserialized_types = {'object_type': 'str', 'text': '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.display.template module

class ask_sdk_model.interfaces.display.template.Template(object_type=None, token=None, back_button=None)

Bases: object

Parameters:

Note

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

ListTemplate2: ask_sdk_model.interfaces.display.list_template2.ListTemplate2,

ListTemplate1: ask_sdk_model.interfaces.display.list_template1.ListTemplate1,

BodyTemplate7: ask_sdk_model.interfaces.display.body_template7.BodyTemplate7,

BodyTemplate6: ask_sdk_model.interfaces.display.body_template6.BodyTemplate6,

BodyTemplate3: ask_sdk_model.interfaces.display.body_template3.BodyTemplate3,

BodyTemplate2: ask_sdk_model.interfaces.display.body_template2.BodyTemplate2,

BodyTemplate1: ask_sdk_model.interfaces.display.body_template1.BodyTemplate1
attribute_map = {'back_button': 'backButton', 'object_type': 'type', 'token': 'token'}
deserialized_types = {'back_button': 'ask_sdk_model.interfaces.display.back_button_behavior.BackButtonBehavior', 'object_type': 'str', 'token': 'str'}
discriminator_value_class_map = {'BodyTemplate1': 'ask_sdk_model.interfaces.display.body_template1.BodyTemplate1', 'BodyTemplate2': 'ask_sdk_model.interfaces.display.body_template2.BodyTemplate2', 'BodyTemplate3': 'ask_sdk_model.interfaces.display.body_template3.BodyTemplate3', 'BodyTemplate6': 'ask_sdk_model.interfaces.display.body_template6.BodyTemplate6', 'BodyTemplate7': 'ask_sdk_model.interfaces.display.body_template7.BodyTemplate7', 'ListTemplate1': 'ask_sdk_model.interfaces.display.list_template1.ListTemplate1', 'ListTemplate2': 'ask_sdk_model.interfaces.display.list_template2.ListTemplate2'}
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.display.text_content module

class ask_sdk_model.interfaces.display.text_content.TextContent(primary_text=None, secondary_text=None, tertiary_text=None)

Bases: object

Parameters:
attribute_map = {'primary_text': 'primaryText', 'secondary_text': 'secondaryText', 'tertiary_text': 'tertiaryText'}
deserialized_types = {'primary_text': 'ask_sdk_model.interfaces.display.text_field.TextField', 'secondary_text': 'ask_sdk_model.interfaces.display.text_field.TextField', 'tertiary_text': 'ask_sdk_model.interfaces.display.text_field.TextField'}
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.display.text_field module

class ask_sdk_model.interfaces.display.text_field.TextField(object_type=None)

Bases: object

Parameters:object_type ((optional) str) –

Note

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

RichText: ask_sdk_model.interfaces.display.rich_text.RichText,

PlainText: ask_sdk_model.interfaces.display.plain_text.PlainText
attribute_map = {'object_type': 'type'}
deserialized_types = {'object_type': 'str'}
discriminator_value_class_map = {'PlainText': 'ask_sdk_model.interfaces.display.plain_text.PlainText', 'RichText': 'ask_sdk_model.interfaces.display.rich_text.RichText'}
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