ask_sdk_model.ui 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.ui.card module

class ask_sdk_model.ui.card.Card(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.

AskForPermissionsConsent: ask_sdk_model.ui.ask_for_permissions_consent_card.AskForPermissionsConsentCard,

LinkAccount: ask_sdk_model.ui.link_account_card.LinkAccountCard,

Standard: ask_sdk_model.ui.standard_card.StandardCard,

Simple: ask_sdk_model.ui.simple_card.SimpleCard
attribute_map = {'object_type': 'type'}
deserialized_types = {'object_type': 'str'}
discriminator_value_class_map = {'AskForPermissionsConsent': 'ask_sdk_model.ui.ask_for_permissions_consent_card.AskForPermissionsConsentCard', 'LinkAccount': 'ask_sdk_model.ui.link_account_card.LinkAccountCard', 'Simple': 'ask_sdk_model.ui.simple_card.SimpleCard', 'Standard': 'ask_sdk_model.ui.standard_card.StandardCard'}
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.ui.image module

class ask_sdk_model.ui.image.Image(small_image_url=None, large_image_url=None)

Bases: object

Parameters:
  • small_image_url ((optional) str) –
  • large_image_url ((optional) str) –
attribute_map = {'large_image_url': 'largeImageUrl', 'small_image_url': 'smallImageUrl'}
deserialized_types = {'large_image_url': 'str', 'small_image_url': '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.ui.output_speech module

class ask_sdk_model.ui.output_speech.OutputSpeech(object_type=None, play_behavior=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.

SSML: ask_sdk_model.ui.ssml_output_speech.SsmlOutputSpeech,

PlainText: ask_sdk_model.ui.plain_text_output_speech.PlainTextOutputSpeech
attribute_map = {'object_type': 'type', 'play_behavior': 'playBehavior'}
deserialized_types = {'object_type': 'str', 'play_behavior': 'ask_sdk_model.ui.play_behavior.PlayBehavior'}
discriminator_value_class_map = {'PlainText': 'ask_sdk_model.ui.plain_text_output_speech.PlainTextOutputSpeech', 'SSML': 'ask_sdk_model.ui.ssml_output_speech.SsmlOutputSpeech'}
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.ui.plain_text_output_speech module

class ask_sdk_model.ui.plain_text_output_speech.PlainTextOutputSpeech(play_behavior=None, text=None)

Bases: ask_sdk_model.ui.output_speech.OutputSpeech

Parameters:
attribute_map = {'object_type': 'type', 'play_behavior': 'playBehavior', 'text': 'text'}
deserialized_types = {'object_type': 'str', 'play_behavior': 'ask_sdk_model.ui.play_behavior.PlayBehavior', '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.ui.play_behavior module

class ask_sdk_model.ui.play_behavior.PlayBehavior

Bases: enum.Enum

Determines whether Alexa will queue or play this output speech immediately interrupting other speech

Allowed enum values: [ENQUEUE, REPLACE_ALL, REPLACE_ENQUEUED]

ENQUEUE = 'ENQUEUE'
REPLACE_ALL = 'REPLACE_ALL'
REPLACE_ENQUEUED = 'REPLACE_ENQUEUED'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.ui.reprompt module

class ask_sdk_model.ui.reprompt.Reprompt(output_speech=None)

Bases: object

Parameters:output_speech ((optional) ask_sdk_model.ui.output_speech.OutputSpeech) –
attribute_map = {'output_speech': 'outputSpeech'}
deserialized_types = {'output_speech': 'ask_sdk_model.ui.output_speech.OutputSpeech'}
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.ui.simple_card module

class ask_sdk_model.ui.simple_card.SimpleCard(title=None, content=None)

Bases: ask_sdk_model.ui.card.Card

Parameters:
  • title ((optional) str) –
  • content ((optional) str) –
attribute_map = {'content': 'content', 'object_type': 'type', 'title': 'title'}
deserialized_types = {'content': 'str', 'object_type': 'str', 'title': '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.ui.ssml_output_speech module

class ask_sdk_model.ui.ssml_output_speech.SsmlOutputSpeech(play_behavior=None, ssml=None)

Bases: ask_sdk_model.ui.output_speech.OutputSpeech

Parameters:
attribute_map = {'object_type': 'type', 'play_behavior': 'playBehavior', 'ssml': 'ssml'}
deserialized_types = {'object_type': 'str', 'play_behavior': 'ask_sdk_model.ui.play_behavior.PlayBehavior', 'ssml': '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.ui.standard_card module

class ask_sdk_model.ui.standard_card.StandardCard(title=None, text=None, image=None)

Bases: ask_sdk_model.ui.card.Card

Parameters:
attribute_map = {'image': 'image', 'object_type': 'type', 'text': 'text', 'title': 'title'}
deserialized_types = {'image': 'ask_sdk_model.ui.image.Image', 'object_type': 'str', 'text': 'str', 'title': 'str'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model