ask_sdk_model.interfaces.system 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.system.error module¶
-
class
ask_sdk_model.interfaces.system.error.
Error
(object_type=None, message=None)¶ Bases:
object
Parameters: - object_type ((optional) ask_sdk_model.interfaces.system.error_type.ErrorType) –
- message ((optional) str) –
-
attribute_map
= {'message': 'message', 'object_type': 'type'}¶
-
deserialized_types
= {'message': 'str', 'object_type': 'ask_sdk_model.interfaces.system.error_type.ErrorType'}¶
-
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.system.error_cause module¶
-
class
ask_sdk_model.interfaces.system.error_cause.
ErrorCause
(request_id=None)¶ Bases:
object
Parameters: request_id ((optional) str) – -
attribute_map
= {'request_id': 'requestId'}¶
-
deserialized_types
= {'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
-
ask_sdk_model.interfaces.system.error_type module¶
-
class
ask_sdk_model.interfaces.system.error_type.
ErrorType
¶ Bases:
enum.Enum
Allowed enum values: [INVALID_RESPONSE, DEVICE_COMMUNICATION_ERROR, INTERNAL_SERVICE_ERROR]
-
DEVICE_COMMUNICATION_ERROR
= 'DEVICE_COMMUNICATION_ERROR'¶
-
INTERNAL_SERVICE_ERROR
= 'INTERNAL_SERVICE_ERROR'¶
-
INVALID_RESPONSE
= 'INVALID_RESPONSE'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_sdk_model.interfaces.system.exception_encountered_request module¶
-
class
ask_sdk_model.interfaces.system.exception_encountered_request.
ExceptionEncounteredRequest
(request_id=None, timestamp=None, locale=None, error=None, cause=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.
- error ((optional) ask_sdk_model.interfaces.system.error.Error) –
- cause ((optional) ask_sdk_model.interfaces.system.error_cause.ErrorCause) –
-
attribute_map
= {'cause': 'cause', 'error': 'error', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}¶
-
deserialized_types
= {'cause': 'ask_sdk_model.interfaces.system.error_cause.ErrorCause', 'error': 'ask_sdk_model.interfaces.system.error.Error', 'locale': 'str', '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.system.system_state module¶
-
class
ask_sdk_model.interfaces.system.system_state.
SystemState
(application=None, user=None, device=None, person=None, api_endpoint=None, api_access_token=None)¶ Bases:
object
Parameters: - application ((optional) ask_sdk_model.application.Application) –
- user ((optional) ask_sdk_model.user.User) –
- device ((optional) ask_sdk_model.device.Device) –
- person ((optional) ask_sdk_model.person.Person) –
- api_endpoint ((optional) str) – A string that references the correct base URI to refer to by region, for use with APIs such as the Device Location API and Progressive Response API.
- api_access_token ((optional) str) – A bearer token string that can be used by the skill (during the skill session) to access Alexa APIs resources of the registered Alexa customer and/or person who is making the request. This token encapsulates the permissions authorized under the registered Alexa account and device, and (optionally) the recognized person. Some resources, such as name or email, require explicit customer consent."
-
attribute_map
= {'api_access_token': 'apiAccessToken', 'api_endpoint': 'apiEndpoint', 'application': 'application', 'device': 'device', 'person': 'person', 'user': 'user'}¶
-
deserialized_types
= {'api_access_token': 'str', 'api_endpoint': 'str', 'application': 'ask_sdk_model.application.Application', 'device': 'ask_sdk_model.device.Device', 'person': 'ask_sdk_model.person.Person', 'user': 'ask_sdk_model.user.User'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model