ask_sdk_model.interfaces.game_engine 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.game_engine.input_handler_event_request module

class ask_sdk_model.interfaces.game_engine.input_handler_event_request.InputHandlerEventRequest(request_id=None, timestamp=None, locale=None, originating_request_id=None, events=None)

Bases: ask_sdk_model.request.Request

Sent when the conditions of an Echo Button event that your skill defined were met.

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.
• originating_request_id ((optional) str) – The corresponding identifier of the request that started the input handler.
• events ((optional) list[ask_sdk_model.services.game_engine.input_handler_event.InputHandlerEvent]) –

attribute_map = {'events': 'events', 'locale': 'locale', 'object_type': 'type', 'originating_request_id': 'originatingRequestId', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'events': 'list[ask_sdk_model.services.game_engine.input_handler_event.InputHandlerEvent]', 'locale': 'str', 'object_type': 'str', 'originating_request_id': '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.game_engine.start_input_handler_directive module

class ask_sdk_model.interfaces.game_engine.start_input_handler_directive.StartInputHandlerDirective(timeout=None, proxies=None, recognizers=None, events=None)

Bases: ask_sdk_model.directive.Directive

Parameters:

• timeout ((optional) int) – The maximum run time for this Input Handler, in milliseconds. Although this parameter is required, you can specify events with conditions on which to end the Input Handler earlier.
• proxies ((optional) list[str]) – Names for unknown gadget IDs to use in recognizers, allocated on a first-come, first-served basis.
• recognizers ((optional) dict(str, ask_sdk_model.services.game_engine.recognizer.Recognizer)) – Conditions that, at any moment, are either true or false. You use recognizers when you specify the conditions under which your skill is notified of Echo Button input.
• events ((optional) dict(str, ask_sdk_model.services.game_engine.event.Event)) – The logic that determines when your skill is notified of Echo Button input. Events are listed here as object keys, where the keys specify the name of an event.

attribute_map = {'events': 'events', 'object_type': 'type', 'proxies': 'proxies', 'recognizers': 'recognizers', 'timeout': 'timeout'}

deserialized_types = {'events': 'dict(str, ask_sdk_model.services.game_engine.event.Event)', 'object_type': 'str', 'proxies': 'list[str]', 'recognizers': 'dict(str, ask_sdk_model.services.game_engine.recognizer.Recognizer)', 'timeout': '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.game_engine.stop_input_handler_directive module

class ask_sdk_model.interfaces.game_engine.stop_input_handler_directive.StopInputHandlerDirective(originating_request_id=None)

Bases: ask_sdk_model.directive.Directive

Parameters:originating_request_id ((optional) str) – The `requestId` of the request that started the input handler.

attribute_map = {'object_type': 'type', 'originating_request_id': 'originatingRequestId'}

deserialized_types = {'object_type': 'str', 'originating_request_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model