ask_smapi_model.v1.skill.manifest 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_smapi_model.v1.skill.manifest.alexa_for_business_apis module¶
-
class
ask_smapi_model.v1.skill.manifest.alexa_for_business_apis.
AlexaForBusinessApis
(regions=None, endpoint=None, interfaces=None)¶ Bases:
object
Defines the structure of alexaForBusiness api in the skill manifest.
Parameters: - regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.region.Region)) – Contains an array of the supported <region> Objects.
- endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) –
- interfaces ((optional) list[ask_smapi_model.v1.skill.manifest.alexa_for_business_interface.AlexaForBusinessInterface]) – Contains the list of supported interfaces.
-
attribute_map
= {'endpoint': 'endpoint', 'interfaces': 'interfaces', 'regions': 'regions'}¶
-
deserialized_types
= {'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint', 'interfaces': 'list[ask_smapi_model.v1.skill.manifest.alexa_for_business_interface.AlexaForBusinessInterface]', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.region.Region)'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.alexa_for_business_interface module¶
-
class
ask_smapi_model.v1.skill.manifest.alexa_for_business_interface.
AlexaForBusinessInterface
(namespace=None, version=None, requests=None)¶ Bases:
object
Parameters: - namespace ((optional) str) – Name of the interface.
- version ((optional) ask_smapi_model.v1.skill.manifest.version.Version) –
- requests ((optional) list[ask_smapi_model.v1.skill.manifest.request.Request]) – Contains a list of requests/messages that skill can handle.
-
attribute_map
= {'namespace': 'namespace', 'requests': 'requests', 'version': 'version'}¶
-
deserialized_types
= {'namespace': 'str', 'requests': 'list[ask_smapi_model.v1.skill.manifest.request.Request]', 'version': 'ask_smapi_model.v1.skill.manifest.version.Version'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.alexa_presentation_apl_interface module¶
-
class
ask_smapi_model.v1.skill.manifest.alexa_presentation_apl_interface.
AlexaPresentationAplInterface
(supported_viewports=None)¶ Bases:
ask_smapi_model.v1.skill.manifest.interface.Interface
Used to declare that the skill uses the Alexa.Presentation.APL interface.
Parameters: supported_viewports ((optional) list[ask_smapi_model.v1.skill.manifest.viewport_specification.ViewportSpecification]) – List of supported viewports. -
attribute_map
= {'object_type': 'type', 'supported_viewports': 'supportedViewports'}¶
-
deserialized_types
= {'object_type': 'str', 'supported_viewports': 'list[ask_smapi_model.v1.skill.manifest.viewport_specification.ViewportSpecification]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.audio_interface module¶
-
class
ask_smapi_model.v1.skill.manifest.audio_interface.
AudioInterface
¶ Bases:
ask_smapi_model.v1.skill.manifest.interface.Interface
-
attribute_map
= {'object_type': 'type'}¶
-
deserialized_types
= {'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_smapi_model.v1.skill.manifest.connections module¶
-
class
ask_smapi_model.v1.skill.manifest.connections.
Connections
(name=None, payload=None)¶ Bases:
object
Skill connection object.
Parameters: - name ((optional) str) – Name of the connection.
- payload ((optional) ask_smapi_model.v1.skill.manifest.connections_payload.ConnectionsPayload) –
-
attribute_map
= {'name': 'name', 'payload': 'payload'}¶
-
deserialized_types
= {'name': 'str', 'payload': 'ask_smapi_model.v1.skill.manifest.connections_payload.ConnectionsPayload'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.connections_payload module¶
-
class
ask_smapi_model.v1.skill.manifest.connections_payload.
ConnectionsPayload
(object_type=None, version=None)¶ Bases:
object
Payload of the connection.
Parameters: -
attribute_map
= {'object_type': 'type', 'version': 'version'}¶
-
deserialized_types
= {'object_type': 'str', '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_smapi_model.v1.skill.manifest.critical_data_handling module¶
ask_smapi_model.v1.skill.manifest.custom_apis module¶
-
class
ask_smapi_model.v1.skill.manifest.custom_apis.
CustomApis
(regions=None, endpoint=None, interfaces=None, tasks=None, connections=None)¶ Bases:
object
Defines the structure for custom api of the skill.
Parameters: - regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.region.Region)) – Contains an array of the supported <region> Objects.
- endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) –
- interfaces ((optional) list[ask_smapi_model.v1.skill.manifest.interface.Interface]) – Defines the structure for interfaces supported by the custom api of the skill.
- tasks ((optional) list[ask_smapi_model.v1.skill.manifest.skill_manifest_custom_task.SkillManifestCustomTask]) – List of provided tasks.
- connections ((optional) ask_smapi_model.v1.skill.manifest.custom_connections.CustomConnections) –
-
attribute_map
= {'connections': 'connections', 'endpoint': 'endpoint', 'interfaces': 'interfaces', 'regions': 'regions', 'tasks': 'tasks'}¶
-
deserialized_types
= {'connections': 'ask_smapi_model.v1.skill.manifest.custom_connections.CustomConnections', 'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint', 'interfaces': 'list[ask_smapi_model.v1.skill.manifest.interface.Interface]', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.region.Region)', 'tasks': 'list[ask_smapi_model.v1.skill.manifest.skill_manifest_custom_task.SkillManifestCustomTask]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.custom_connections module¶
-
class
ask_smapi_model.v1.skill.manifest.custom_connections.
CustomConnections
(requires=None, provides=None)¶ Bases:
object
Supported connections.
Parameters: - requires ((optional) list[ask_smapi_model.v1.skill.manifest.connections.Connections]) – List of required connections.
- provides ((optional) list[ask_smapi_model.v1.skill.manifest.connections.Connections]) – List of provided connections.
-
attribute_map
= {'provides': 'provides', 'requires': 'requires'}¶
-
deserialized_types
= {'provides': 'list[ask_smapi_model.v1.skill.manifest.connections.Connections]', 'requires': 'list[ask_smapi_model.v1.skill.manifest.connections.Connections]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.custom_interface module¶
-
class
ask_smapi_model.v1.skill.manifest.custom_interface.
CustomInterface
¶ Bases:
ask_smapi_model.v1.skill.manifest.interface.Interface
Skills using Custom Interfaces can send custom directives and receive custom events from custom endpoints such as Alexa gadgets.
-
attribute_map
= {'object_type': 'type'}¶
-
deserialized_types
= {'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_smapi_model.v1.skill.manifest.data_protection_provider module¶
ask_smapi_model.v1.skill.manifest.display_interface module¶
-
class
ask_smapi_model.v1.skill.manifest.display_interface.
DisplayInterface
(minimum_template_version=None, minimum_apml_version=None)¶ Bases:
ask_smapi_model.v1.skill.manifest.interface.Interface
Used to declare that the skill uses the Display interface. When a skill declares that it uses the Display interface the Display interface will be passed in the supportedInterfaces section of devices which meet any of the required minimum version attributes specified in the manifest. If the device does not meet any of the minimum versions specified in the manifest the Display interface will not be present in the supportedInterfaces section. If neither the minimumTemplateVersion nor the minimumApmlVersion attributes are specified in the manifes then the minimumTemplateVersion is defaulted to 1.0 and apmlVersion is omitted.
Parameters: - minimum_template_version ((optional) ask_smapi_model.v1.skill.manifest.display_interface_template_version.DisplayInterfaceTemplateVersion) –
- minimum_apml_version ((optional) ask_smapi_model.v1.skill.manifest.display_interface_apml_version.DisplayInterfaceApmlVersion) –
-
attribute_map
= {'minimum_apml_version': 'minimumApmlVersion', 'minimum_template_version': 'minimumTemplateVersion', 'object_type': 'type'}¶
-
deserialized_types
= {'minimum_apml_version': 'ask_smapi_model.v1.skill.manifest.display_interface_apml_version.DisplayInterfaceApmlVersion', 'minimum_template_version': 'ask_smapi_model.v1.skill.manifest.display_interface_template_version.DisplayInterfaceTemplateVersion', '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_smapi_model.v1.skill.manifest.display_interface_apml_version module¶
-
class
ask_smapi_model.v1.skill.manifest.display_interface_apml_version.
DisplayInterfaceApmlVersion
¶ Bases:
enum.Enum
The minimum version of the APML specification supported by the skill. If a device does not support a version greater than or equal to the version specified her then apmlVersion will not be passed inside the Display interface in the ASK request.
Allowed enum values: [_0_2]
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.display_interface_template_version module¶
-
class
ask_smapi_model.v1.skill.manifest.display_interface_template_version.
DisplayInterfaceTemplateVersion
¶ Bases:
enum.Enum
The minimum version of pre-defined templates supported by the skill. If a device does not support a version greater than or equal to the version specified her then templateVersion will not be passed inside the Display interface in the ASK request.
Allowed enum values: [_1]
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.distribution_countries module¶
-
class
ask_smapi_model.v1.skill.manifest.distribution_countries.
DistributionCountries
¶ Bases:
enum.Enum
Allowed enum values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SR, SJ, SZ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]
-
AD
= 'AD'¶
-
AE
= 'AE'¶
-
AF
= 'AF'¶
-
AG
= 'AG'¶
-
AI
= 'AI'¶
-
AL
= 'AL'¶
-
AM
= 'AM'¶
-
AN
= 'AN'¶
-
AO
= 'AO'¶
-
AQ
= 'AQ'¶
-
AR
= 'AR'¶
-
AS
= 'AS'¶
-
AT
= 'AT'¶
-
AU
= 'AU'¶
-
AW
= 'AW'¶
-
AX
= 'AX'¶
-
AZ
= 'AZ'¶
-
BA
= 'BA'¶
-
BB
= 'BB'¶
-
BD
= 'BD'¶
-
BE
= 'BE'¶
-
BF
= 'BF'¶
-
BG
= 'BG'¶
-
BH
= 'BH'¶
-
BI
= 'BI'¶
-
BJ
= 'BJ'¶
-
BL
= 'BL'¶
-
BM
= 'BM'¶
-
BN
= 'BN'¶
-
BO
= 'BO'¶
-
BR
= 'BR'¶
-
BS
= 'BS'¶
-
BT
= 'BT'¶
-
BV
= 'BV'¶
-
BW
= 'BW'¶
-
BY
= 'BY'¶
-
BZ
= 'BZ'¶
-
CA
= 'CA'¶
-
CC
= 'CC'¶
-
CD
= 'CD'¶
-
CF
= 'CF'¶
-
CG
= 'CG'¶
-
CH
= 'CH'¶
-
CI
= 'CI'¶
-
CK
= 'CK'¶
-
CL
= 'CL'¶
-
CM
= 'CM'¶
-
CN
= 'CN'¶
-
CO
= 'CO'¶
-
CR
= 'CR'¶
-
CV
= 'CV'¶
-
CX
= 'CX'¶
-
CY
= 'CY'¶
-
CZ
= 'CZ'¶
-
DE
= 'DE'¶
-
DJ
= 'DJ'¶
-
DK
= 'DK'¶
-
DM
= 'DM'¶
-
DO
= 'DO'¶
-
DZ
= 'DZ'¶
-
EC
= 'EC'¶
-
EE
= 'EE'¶
-
EG
= 'EG'¶
-
EH
= 'EH'¶
-
ER
= 'ER'¶
-
ES
= 'ES'¶
-
ET
= 'ET'¶
-
FI
= 'FI'¶
-
FJ
= 'FJ'¶
-
FK
= 'FK'¶
-
FM
= 'FM'¶
-
FO
= 'FO'¶
-
FR
= 'FR'¶
-
GA
= 'GA'¶
-
GB
= 'GB'¶
-
GD
= 'GD'¶
-
GE
= 'GE'¶
-
GF
= 'GF'¶
-
GG
= 'GG'¶
-
GH
= 'GH'¶
-
GI
= 'GI'¶
-
GL
= 'GL'¶
-
GM
= 'GM'¶
-
GN
= 'GN'¶
-
GP
= 'GP'¶
-
GQ
= 'GQ'¶
-
GR
= 'GR'¶
-
GS
= 'GS'¶
-
GT
= 'GT'¶
-
GU
= 'GU'¶
-
GW
= 'GW'¶
-
GY
= 'GY'¶
-
HK
= 'HK'¶
-
HM
= 'HM'¶
-
HN
= 'HN'¶
-
HR
= 'HR'¶
-
HT
= 'HT'¶
-
HU
= 'HU'¶
-
ID
= 'ID'¶
-
IE
= 'IE'¶
-
IL
= 'IL'¶
-
IM
= 'IM'¶
-
IN
= 'IN'¶
-
IO
= 'IO'¶
-
IQ
= 'IQ'¶
-
IS
= 'IS'¶
-
IT
= 'IT'¶
-
JE
= 'JE'¶
-
JM
= 'JM'¶
-
JO
= 'JO'¶
-
JP
= 'JP'¶
-
KE
= 'KE'¶
-
KG
= 'KG'¶
-
KH
= 'KH'¶
-
KI
= 'KI'¶
-
KM
= 'KM'¶
-
KN
= 'KN'¶
-
KR
= 'KR'¶
-
KW
= 'KW'¶
-
KY
= 'KY'¶
-
KZ
= 'KZ'¶
-
LA
= 'LA'¶
-
LB
= 'LB'¶
-
LC
= 'LC'¶
-
LI
= 'LI'¶
-
LK
= 'LK'¶
-
LR
= 'LR'¶
-
LS
= 'LS'¶
-
LT
= 'LT'¶
-
LU
= 'LU'¶
-
LV
= 'LV'¶
-
LY
= 'LY'¶
-
MA
= 'MA'¶
-
MC
= 'MC'¶
-
MD
= 'MD'¶
-
ME
= 'ME'¶
-
MF
= 'MF'¶
-
MG
= 'MG'¶
-
MH
= 'MH'¶
-
MK
= 'MK'¶
-
ML
= 'ML'¶
-
MM
= 'MM'¶
-
MN
= 'MN'¶
-
MO
= 'MO'¶
-
MP
= 'MP'¶
-
MQ
= 'MQ'¶
-
MR
= 'MR'¶
-
MS
= 'MS'¶
-
MT
= 'MT'¶
-
MU
= 'MU'¶
-
MV
= 'MV'¶
-
MW
= 'MW'¶
-
MX
= 'MX'¶
-
MY
= 'MY'¶
-
MZ
= 'MZ'¶
-
NA
= 'NA'¶
-
NC
= 'NC'¶
-
NE
= 'NE'¶
-
NF
= 'NF'¶
-
NG
= 'NG'¶
-
NI
= 'NI'¶
-
NL
= 'NL'¶
-
NO
= 'NO'¶
-
NP
= 'NP'¶
-
NR
= 'NR'¶
-
NU
= 'NU'¶
-
NZ
= 'NZ'¶
-
OM
= 'OM'¶
-
PA
= 'PA'¶
-
PE
= 'PE'¶
-
PF
= 'PF'¶
-
PG
= 'PG'¶
-
PH
= 'PH'¶
-
PK
= 'PK'¶
-
PL
= 'PL'¶
-
PM
= 'PM'¶
-
PN
= 'PN'¶
-
PR
= 'PR'¶
-
PS
= 'PS'¶
-
PT
= 'PT'¶
-
PW
= 'PW'¶
-
PY
= 'PY'¶
-
QA
= 'QA'¶
-
RE
= 'RE'¶
-
RO
= 'RO'¶
-
RS
= 'RS'¶
-
RU
= 'RU'¶
-
RW
= 'RW'¶
-
SA
= 'SA'¶
-
SB
= 'SB'¶
-
SC
= 'SC'¶
-
SE
= 'SE'¶
-
SG
= 'SG'¶
-
SH
= 'SH'¶
-
SI
= 'SI'¶
-
SJ
= 'SJ'¶
-
SK
= 'SK'¶
-
SL
= 'SL'¶
-
SM
= 'SM'¶
-
SN
= 'SN'¶
-
SO
= 'SO'¶
-
SR
= 'SR'¶
-
ST
= 'ST'¶
-
SV
= 'SV'¶
-
SZ
= 'SZ'¶
-
TC
= 'TC'¶
-
TD
= 'TD'¶
-
TF
= 'TF'¶
-
TG
= 'TG'¶
-
TH
= 'TH'¶
-
TJ
= 'TJ'¶
-
TK
= 'TK'¶
-
TL
= 'TL'¶
-
TM
= 'TM'¶
-
TN
= 'TN'¶
-
TO
= 'TO'¶
-
TR
= 'TR'¶
-
TT
= 'TT'¶
-
TV
= 'TV'¶
-
TW
= 'TW'¶
-
TZ
= 'TZ'¶
-
UA
= 'UA'¶
-
UG
= 'UG'¶
-
UM
= 'UM'¶
-
US
= 'US'¶
-
UY
= 'UY'¶
-
UZ
= 'UZ'¶
-
VA
= 'VA'¶
-
VC
= 'VC'¶
-
VE
= 'VE'¶
-
VG
= 'VG'¶
-
VI
= 'VI'¶
-
VN
= 'VN'¶
-
VU
= 'VU'¶
-
WF
= 'WF'¶
-
WS
= 'WS'¶
-
YE
= 'YE'¶
-
YT
= 'YT'¶
-
ZA
= 'ZA'¶
-
ZM
= 'ZM'¶
-
ZW
= 'ZW'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.distribution_mode module¶
-
class
ask_smapi_model.v1.skill.manifest.distribution_mode.
DistributionMode
¶ Bases:
enum.Enum
What audience the skill should be distributed to. "PUBLIC" - available to all users. Has ASIN and can be enabled. "PRIVATE" - available to entitled users. Has ASIN and can be enabled. "INTERNAL" - has no ASIN and cannot be enabled by users. Internally managed skills.
Allowed enum values: [PRIVATE, PUBLIC, INTERNAL]
-
INTERNAL
= 'INTERNAL'¶
-
PRIVATE
= 'PRIVATE'¶
-
PUBLIC
= 'PUBLIC'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.event_name module¶
-
class
ask_smapi_model.v1.skill.manifest.event_name.
EventName
(event_name=None)¶ Bases:
object
Parameters: event_name ((optional) ask_smapi_model.v1.skill.manifest.event_name_type.EventNameType) – -
attribute_map
= {'event_name': 'eventName'}¶
-
deserialized_types
= {'event_name': 'ask_smapi_model.v1.skill.manifest.event_name_type.EventNameType'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.event_name_type module¶
-
class
ask_smapi_model.v1.skill.manifest.event_name_type.
EventNameType
¶ Bases:
enum.Enum
Name of the event to be subscribed to.
Allowed enum values: [SKILL_ENABLED, SKILL_DISABLED, SKILL_PERMISSION_ACCEPTED, SKILL_PERMISSION_CHANGED, SKILL_ACCOUNT_LINKED, ITEMS_CREATED, ITEMS_UPDATED, ITEMS_DELETED, LIST_CREATED, LIST_UPDATED, LIST_DELETED, ALL_LISTS_CHANGED, REMINDER_STARTED, REMINDER_CREATED, REMINDER_UPDATED, REMINDER_DELETED, REMINDER_STATUS_CHANGED, AUDIO_ITEM_PLAYBACK_STARTED, AUDIO_ITEM_PLAYBACK_FINISHED, AUDIO_ITEM_PLAYBACK_STOPPED, AUDIO_ITEM_PLAYBACK_FAILED, SKILL_PROACTIVE_SUBSCRIPTION_CHANGED, IN_SKILL_PRODUCT_SUBSCRIPTION_STARTED, IN_SKILL_PRODUCT_SUBSCRIPTION_RENEWED, IN_SKILL_PRODUCT_SUBSCRIPTION_ENDED, Legacy_ActivityManager_ActivityContextRemovedEvent, Legacy_ActivityManager_ActivityInterrupted, Legacy_ActivityManager_FocusChanged, Legacy_AlertsController_DismissCommand, Legacy_AlertsController_SnoozeCommand, Legacy_AudioPlayer_AudioStutter, Legacy_AudioPlayer_InitialPlaybackProgressReport, Legacy_AudioPlayer_Metadata, Legacy_AudioPlayer_PeriodicPlaybackProgressReport, Legacy_AudioPlayer_PlaybackError, Legacy_AudioPlayer_PlaybackFinished, Legacy_AudioPlayer_PlaybackIdle, Legacy_AudioPlayer_PlaybackInterrupted, Legacy_AudioPlayer_PlaybackNearlyFinished, Legacy_AudioPlayer_PlaybackPaused, Legacy_AudioPlayer_PlaybackResumed, Legacy_AudioPlayer_PlaybackStarted, Legacy_AudioPlayer_PlaybackStutterFinished, Legacy_AudioPlayer_PlaybackStutterStarted, Legacy_AudioPlayerGui_ButtonClickedEvent, Legacy_AudioPlayerGui_LyricsViewedEvent, Legacy_AuxController_DirectionChanged, Legacy_AuxController_EnabledStateChanged, Legacy_AuxController_InputActivityStateChanged, Legacy_AuxController_PluggedStateChanged, Legacy_BluetoothNetwork_CancelPairingMode, Legacy_BluetoothNetwork_DeviceConnectedFailure, Legacy_BluetoothNetwork_DeviceConnectedSuccess, Legacy_BluetoothNetwork_DeviceDisconnectedFailure, Legacy_BluetoothNetwork_DeviceDisconnectedSuccess, Legacy_BluetoothNetwork_DevicePairFailure, Legacy_BluetoothNetwork_DevicePairSuccess, Legacy_BluetoothNetwork_DeviceUnpairFailure, Legacy_BluetoothNetwork_DeviceUnpairSuccess, Legacy_BluetoothNetwork_EnterPairingModeFailure, Legacy_BluetoothNetwork_EnterPairingModeSuccess, Legacy_BluetoothNetwork_MediaControlFailure, Legacy_BluetoothNetwork_MediaControlSuccess, Legacy_BluetoothNetwork_ScanDevicesReport, Legacy_BluetoothNetwork_SetDeviceCategoriesFailed, Legacy_BluetoothNetwork_SetDeviceCategoriesSucceeded, Legacy_ContentManager_ContentPlaybackTerminated, Legacy_DeviceNotification_DeleteNotificationFailed, Legacy_DeviceNotification_DeleteNotificationSucceeded, Legacy_DeviceNotification_NotificationEnteredBackground, Legacy_DeviceNotification_NotificationEnteredForground, Legacy_DeviceNotification_NotificationStarted, Legacy_DeviceNotification_NotificationStopped, Legacy_DeviceNotification_NotificationSync, Legacy_DeviceNotification_SetNotificationFailed, Legacy_DeviceNotification_SetNotificationSucceeded, Legacy_EqualizerController_EqualizerChanged, Legacy_ExternalMediaPlayer_AuthorizationComplete, Legacy_ExternalMediaPlayer_Error, Legacy_ExternalMediaPlayer_Event, Legacy_ExternalMediaPlayer_Login, Legacy_ExternalMediaPlayer_Logout, Legacy_ExternalMediaPlayer_ReportDiscoveredPlayers, Legacy_ExternalMediaPlayer_RequestToken, Legacy_FavoritesController_Error, Legacy_FavoritesController_Response, Legacy_GameEngine_GameInputEvent, Legacy_HomeAutoWifiController_DeviceReconnected, Legacy_HomeAutoWifiController_HttpNotified, Legacy_HomeAutoWifiController_SsdpDiscoveryFinished, Legacy_HomeAutoWifiController_SsdpServiceDiscovered, Legacy_HomeAutoWifiController_SsdpServiceTerminated, Legacy_ListModel_AddItemRequest, Legacy_ListModel_DeleteItemRequest, Legacy_ListModel_GetPageByOrdinalRequest, Legacy_ListModel_GetPageByTokenRequest, Legacy_ListModel_ListStateUpdateRequest, Legacy_ListModel_UpdateItemRequest, Legacy_ListRenderer_GetListPageByOrdinal, Legacy_ListRenderer_GetListPageByToken, Legacy_ListRenderer_ListItemEvent, Legacy_MediaGrouping_GroupChangeNotificationEvent, Legacy_MediaGrouping_GroupChangeResponseEvent, Legacy_MediaGrouping_GroupSyncEvent, Legacy_MediaPlayer_PlaybackError, Legacy_MediaPlayer_PlaybackFinished, Legacy_MediaPlayer_PlaybackIdle, Legacy_MediaPlayer_PlaybackNearlyFinished, Legacy_MediaPlayer_PlaybackPaused, Legacy_MediaPlayer_PlaybackResumed, Legacy_MediaPlayer_PlaybackStarted, Legacy_MediaPlayer_PlaybackStopped, Legacy_MediaPlayer_SequenceItemsRequested, Legacy_MediaPlayer_SequenceModified, Legacy_MeetingClientController_Event, Legacy_Microphone_AudioRecording, Legacy_PhoneCallController_Event, Legacy_PlaybackController_ButtonCommand, Legacy_PlaybackController_LyricsViewedEvent, Legacy_PlaybackController_NextCommand, Legacy_PlaybackController_PauseCommand, Legacy_PlaybackController_PlayCommand, Legacy_PlaybackController_PreviousCommand, Legacy_PlaybackController_ToggleCommand, Legacy_PlaylistController_ErrorResponse, Legacy_PlaylistController_Response, Legacy_Presentation_PresentationDismissedEvent, Legacy_Presentation_PresentationUserEvent, Legacy_SconeRemoteControl_Next, Legacy_SconeRemoteControl_PlayPause, Legacy_SconeRemoteControl_Previous, Legacy_SconeRemoteControl_VolumeDown, Legacy_SconeRemoteControl_VolumeUp, Legacy_SipClient_Event, Legacy_SoftwareUpdate_CheckSoftwareUpdateReport, Legacy_SoftwareUpdate_InitiateSoftwareUpdateReport, Legacy_Speaker_MuteChanged, Legacy_Speaker_VolumeChanged, Legacy_SpeechRecognizer_WakeWordChanged, Legacy_SpeechSynthesizer_SpeechFinished, Legacy_SpeechSynthesizer_SpeechInterrupted, Legacy_SpeechSynthesizer_SpeechStarted, Legacy_SpeechSynthesizer_SpeechSynthesizerError, Legacy_Spotify_Event, Legacy_System_UserInactivity, Legacy_UDPController_BroadcastResponse, LocalApplication_Alexa_Translation_LiveTranslation_Event, LocalApplication_AlexaNotifications_Event, LocalApplication_AlexaPlatformTestSpeechlet_Event, LocalApplication_AlexaVision_Event, LocalApplication_AlexaVoiceLayer_Event, LocalApplication_AvaPhysicalShopping_Event, LocalApplication_Calendar_Event, LocalApplication_Closet_Event, LocalApplication_Communications_Event, LocalApplication_DeviceMessaging_Event, LocalApplication_DigitalDash_Event, LocalApplication_FireflyShopping_Event, LocalApplication_Gallery_Event, LocalApplication_HHOPhotos_Event, LocalApplication_HomeAutomationMedia_Event, LocalApplication_KnightContacts_Event, LocalApplication_KnightHome_Event, LocalApplication_KnightHomeThingsToTry_Event, LocalApplication_LocalMediaPlayer_Event, LocalApplication_LocalVoiceUI_Event, LocalApplication_MShop_Event, LocalApplication_MShopPurchasing_Event, LocalApplication_NotificationsApp_Event, LocalApplication_Photos_Event, LocalApplication_Sentry_Event, LocalApplication_SipClient_Event, LocalApplication_SipUserAgent_Event, LocalApplication_todoRenderer_Event, LocalApplication_VideoExperienceService_Event, LocalApplication_WebVideoPlayer_Event, Alexa_Camera_PhotoCaptureController_CancelCaptureFailed, Alexa_Camera_PhotoCaptureController_CancelCaptureFinished, Alexa_Camera_PhotoCaptureController_CaptureFailed, Alexa_Camera_PhotoCaptureController_CaptureFinished, Alexa_Camera_VideoCaptureController_CancelCaptureFailed, Alexa_Camera_VideoCaptureController_CancelCaptureFinished, Alexa_Camera_VideoCaptureController_CaptureFailed, Alexa_Camera_VideoCaptureController_CaptureFinished, Alexa_Camera_VideoCaptureController_CaptureStarted, Alexa_FileManager_UploadController_CancelUploadFailed, Alexa_FileManager_UploadController_CancelUploadFinished, Alexa_FileManager_UploadController_UploadFailed, Alexa_FileManager_UploadController_UploadFinished, Alexa_FileManager_UploadController_UploadStarted, Alexa_Presentation_APL_UserEvent, Alexa_Presentation_HTML_Event, Alexa_Presentation_HTML_LifecycleStateChanged, Alexa_Presentation_PresentationDismissed, AudioPlayer_PlaybackFailed, AudioPlayer_PlaybackFinished, AudioPlayer_PlaybackNearlyFinished, AudioPlayer_PlaybackStarted, AudioPlayer_PlaybackStopped, CardRenderer_DisplayContentFinished, CardRenderer_DisplayContentStarted, CardRenderer_ReadContentFinished, CardRenderer_ReadContentStarted, CustomInterfaceController_EventsReceived, CustomInterfaceController_Expired, DeviceSetup_SetupCompleted, Display_ElementSelected, Display_UserEvent, FitnessSessionController_FitnessSessionEnded, FitnessSessionController_FitnessSessionError, FitnessSessionController_FitnessSessionPaused, FitnessSessionController_FitnessSessionResumed, FitnessSessionController_FitnessSessionStarted, GameEngine_InputHandlerEvent, Messaging_MessageReceived, MessagingController_UpdateConversationsStatus, MessagingController_UpdateMessagesStatusRequest, MessagingController_UpdateSendMessageStatusRequest, MessagingController_UploadConversations, PlaybackController_NextCommandIssued, PlaybackController_PauseCommandIssued, PlaybackController_PlayCommandIssued, PlaybackController_PreviousCommandIssued, EffectsController_RequestEffectChangeRequest, EffectsController_RequestGuiChangeRequest, EffectsController_StateReceiptChangeRequest, Alexa_Video_Xray_ShowDetailsSuccessful, Alexa_Video_Xray_ShowDetailsFailed]
-
ALL_LISTS_CHANGED
= 'ALL_LISTS_CHANGED'¶
-
AUDIO_ITEM_PLAYBACK_FAILED
= 'AUDIO_ITEM_PLAYBACK_FAILED'¶
-
AUDIO_ITEM_PLAYBACK_FINISHED
= 'AUDIO_ITEM_PLAYBACK_FINISHED'¶
-
AUDIO_ITEM_PLAYBACK_STARTED
= 'AUDIO_ITEM_PLAYBACK_STARTED'¶
-
AUDIO_ITEM_PLAYBACK_STOPPED
= 'AUDIO_ITEM_PLAYBACK_STOPPED'¶
-
Alexa_Camera_PhotoCaptureController_CancelCaptureFailed
= 'Alexa.Camera.PhotoCaptureController.CancelCaptureFailed'¶
-
Alexa_Camera_PhotoCaptureController_CancelCaptureFinished
= 'Alexa.Camera.PhotoCaptureController.CancelCaptureFinished'¶
-
Alexa_Camera_PhotoCaptureController_CaptureFailed
= 'Alexa.Camera.PhotoCaptureController.CaptureFailed'¶
-
Alexa_Camera_PhotoCaptureController_CaptureFinished
= 'Alexa.Camera.PhotoCaptureController.CaptureFinished'¶
-
Alexa_Camera_VideoCaptureController_CancelCaptureFailed
= 'Alexa.Camera.VideoCaptureController.CancelCaptureFailed'¶
-
Alexa_Camera_VideoCaptureController_CancelCaptureFinished
= 'Alexa.Camera.VideoCaptureController.CancelCaptureFinished'¶
-
Alexa_Camera_VideoCaptureController_CaptureFailed
= 'Alexa.Camera.VideoCaptureController.CaptureFailed'¶
-
Alexa_Camera_VideoCaptureController_CaptureFinished
= 'Alexa.Camera.VideoCaptureController.CaptureFinished'¶
-
Alexa_Camera_VideoCaptureController_CaptureStarted
= 'Alexa.Camera.VideoCaptureController.CaptureStarted'¶
-
Alexa_FileManager_UploadController_CancelUploadFailed
= 'Alexa.FileManager.UploadController.CancelUploadFailed'¶
-
Alexa_FileManager_UploadController_CancelUploadFinished
= 'Alexa.FileManager.UploadController.CancelUploadFinished'¶
-
Alexa_FileManager_UploadController_UploadFailed
= 'Alexa.FileManager.UploadController.UploadFailed'¶
-
Alexa_FileManager_UploadController_UploadFinished
= 'Alexa.FileManager.UploadController.UploadFinished'¶
-
Alexa_FileManager_UploadController_UploadStarted
= 'Alexa.FileManager.UploadController.UploadStarted'¶
-
Alexa_Presentation_APL_UserEvent
= 'Alexa.Presentation.APL.UserEvent'¶
-
Alexa_Presentation_HTML_Event
= 'Alexa.Presentation.HTML.Event'¶
-
Alexa_Presentation_HTML_LifecycleStateChanged
= 'Alexa.Presentation.HTML.LifecycleStateChanged'¶
-
Alexa_Presentation_PresentationDismissed
= 'Alexa.Presentation.PresentationDismissed'¶
-
Alexa_Video_Xray_ShowDetailsFailed
= 'Alexa.Video.Xray.ShowDetailsFailed'¶
-
Alexa_Video_Xray_ShowDetailsSuccessful
= 'Alexa.Video.Xray.ShowDetailsSuccessful'¶
-
AudioPlayer_PlaybackFailed
= 'AudioPlayer.PlaybackFailed'¶
-
AudioPlayer_PlaybackFinished
= 'AudioPlayer.PlaybackFinished'¶
-
AudioPlayer_PlaybackNearlyFinished
= 'AudioPlayer.PlaybackNearlyFinished'¶
-
AudioPlayer_PlaybackStarted
= 'AudioPlayer.PlaybackStarted'¶
-
AudioPlayer_PlaybackStopped
= 'AudioPlayer.PlaybackStopped'¶
-
CardRenderer_DisplayContentFinished
= 'CardRenderer.DisplayContentFinished'¶
-
CardRenderer_DisplayContentStarted
= 'CardRenderer.DisplayContentStarted'¶
-
CardRenderer_ReadContentFinished
= 'CardRenderer.ReadContentFinished'¶
-
CardRenderer_ReadContentStarted
= 'CardRenderer.ReadContentStarted'¶
-
CustomInterfaceController_EventsReceived
= 'CustomInterfaceController.EventsReceived'¶
-
CustomInterfaceController_Expired
= 'CustomInterfaceController.Expired'¶
-
DeviceSetup_SetupCompleted
= 'DeviceSetup.SetupCompleted'¶
-
Display_ElementSelected
= 'Display.ElementSelected'¶
-
Display_UserEvent
= 'Display.UserEvent'¶
-
EffectsController_RequestEffectChangeRequest
= 'EffectsController.RequestEffectChangeRequest'¶
-
EffectsController_RequestGuiChangeRequest
= 'EffectsController.RequestGuiChangeRequest'¶
-
EffectsController_StateReceiptChangeRequest
= 'EffectsController.StateReceiptChangeRequest'¶
-
FitnessSessionController_FitnessSessionEnded
= 'FitnessSessionController.FitnessSessionEnded'¶
-
FitnessSessionController_FitnessSessionError
= 'FitnessSessionController.FitnessSessionError'¶
-
FitnessSessionController_FitnessSessionPaused
= 'FitnessSessionController.FitnessSessionPaused'¶
-
FitnessSessionController_FitnessSessionResumed
= 'FitnessSessionController.FitnessSessionResumed'¶
-
FitnessSessionController_FitnessSessionStarted
= 'FitnessSessionController.FitnessSessionStarted'¶
-
GameEngine_InputHandlerEvent
= 'GameEngine.InputHandlerEvent'¶
-
IN_SKILL_PRODUCT_SUBSCRIPTION_ENDED
= 'IN_SKILL_PRODUCT_SUBSCRIPTION_ENDED'¶
-
IN_SKILL_PRODUCT_SUBSCRIPTION_RENEWED
= 'IN_SKILL_PRODUCT_SUBSCRIPTION_RENEWED'¶
-
IN_SKILL_PRODUCT_SUBSCRIPTION_STARTED
= 'IN_SKILL_PRODUCT_SUBSCRIPTION_STARTED'¶
-
ITEMS_CREATED
= 'ITEMS_CREATED'¶
-
ITEMS_DELETED
= 'ITEMS_DELETED'¶
-
ITEMS_UPDATED
= 'ITEMS_UPDATED'¶
-
LIST_CREATED
= 'LIST_CREATED'¶
-
LIST_DELETED
= 'LIST_DELETED'¶
-
LIST_UPDATED
= 'LIST_UPDATED'¶
-
Legacy_ActivityManager_ActivityContextRemovedEvent
= 'Legacy.ActivityManager.ActivityContextRemovedEvent'¶
-
Legacy_ActivityManager_ActivityInterrupted
= 'Legacy.ActivityManager.ActivityInterrupted'¶
-
Legacy_ActivityManager_FocusChanged
= 'Legacy.ActivityManager.FocusChanged'¶
-
Legacy_AlertsController_DismissCommand
= 'Legacy.AlertsController.DismissCommand'¶
-
Legacy_AlertsController_SnoozeCommand
= 'Legacy.AlertsController.SnoozeCommand'¶
-
Legacy_AudioPlayerGui_ButtonClickedEvent
= 'Legacy.AudioPlayerGui.ButtonClickedEvent'¶
-
Legacy_AudioPlayerGui_LyricsViewedEvent
= 'Legacy.AudioPlayerGui.LyricsViewedEvent'¶
-
Legacy_AudioPlayer_AudioStutter
= 'Legacy.AudioPlayer.AudioStutter'¶
-
Legacy_AudioPlayer_InitialPlaybackProgressReport
= 'Legacy.AudioPlayer.InitialPlaybackProgressReport'¶
-
Legacy_AudioPlayer_Metadata
= 'Legacy.AudioPlayer.Metadata'¶
-
Legacy_AudioPlayer_PeriodicPlaybackProgressReport
= 'Legacy.AudioPlayer.PeriodicPlaybackProgressReport'¶
-
Legacy_AudioPlayer_PlaybackError
= 'Legacy.AudioPlayer.PlaybackError'¶
-
Legacy_AudioPlayer_PlaybackFinished
= 'Legacy.AudioPlayer.PlaybackFinished'¶
-
Legacy_AudioPlayer_PlaybackIdle
= 'Legacy.AudioPlayer.PlaybackIdle'¶
-
Legacy_AudioPlayer_PlaybackInterrupted
= 'Legacy.AudioPlayer.PlaybackInterrupted'¶
-
Legacy_AudioPlayer_PlaybackNearlyFinished
= 'Legacy.AudioPlayer.PlaybackNearlyFinished'¶
-
Legacy_AudioPlayer_PlaybackPaused
= 'Legacy.AudioPlayer.PlaybackPaused'¶
-
Legacy_AudioPlayer_PlaybackResumed
= 'Legacy.AudioPlayer.PlaybackResumed'¶
-
Legacy_AudioPlayer_PlaybackStarted
= 'Legacy.AudioPlayer.PlaybackStarted'¶
-
Legacy_AudioPlayer_PlaybackStutterFinished
= 'Legacy.AudioPlayer.PlaybackStutterFinished'¶
-
Legacy_AudioPlayer_PlaybackStutterStarted
= 'Legacy.AudioPlayer.PlaybackStutterStarted'¶
-
Legacy_AuxController_DirectionChanged
= 'Legacy.AuxController.DirectionChanged'¶
-
Legacy_AuxController_EnabledStateChanged
= 'Legacy.AuxController.EnabledStateChanged'¶
-
Legacy_AuxController_InputActivityStateChanged
= 'Legacy.AuxController.InputActivityStateChanged'¶
-
Legacy_AuxController_PluggedStateChanged
= 'Legacy.AuxController.PluggedStateChanged'¶
-
Legacy_BluetoothNetwork_CancelPairingMode
= 'Legacy.BluetoothNetwork.CancelPairingMode'¶
-
Legacy_BluetoothNetwork_DeviceConnectedFailure
= 'Legacy.BluetoothNetwork.DeviceConnectedFailure'¶
-
Legacy_BluetoothNetwork_DeviceConnectedSuccess
= 'Legacy.BluetoothNetwork.DeviceConnectedSuccess'¶
-
Legacy_BluetoothNetwork_DeviceDisconnectedFailure
= 'Legacy.BluetoothNetwork.DeviceDisconnectedFailure'¶
-
Legacy_BluetoothNetwork_DeviceDisconnectedSuccess
= 'Legacy.BluetoothNetwork.DeviceDisconnectedSuccess'¶
-
Legacy_BluetoothNetwork_DevicePairFailure
= 'Legacy.BluetoothNetwork.DevicePairFailure'¶
-
Legacy_BluetoothNetwork_DevicePairSuccess
= 'Legacy.BluetoothNetwork.DevicePairSuccess'¶
-
Legacy_BluetoothNetwork_DeviceUnpairFailure
= 'Legacy.BluetoothNetwork.DeviceUnpairFailure'¶
-
Legacy_BluetoothNetwork_DeviceUnpairSuccess
= 'Legacy.BluetoothNetwork.DeviceUnpairSuccess'¶
-
Legacy_BluetoothNetwork_EnterPairingModeFailure
= 'Legacy.BluetoothNetwork.EnterPairingModeFailure'¶
-
Legacy_BluetoothNetwork_EnterPairingModeSuccess
= 'Legacy.BluetoothNetwork.EnterPairingModeSuccess'¶
-
Legacy_BluetoothNetwork_MediaControlFailure
= 'Legacy.BluetoothNetwork.MediaControlFailure'¶
-
Legacy_BluetoothNetwork_MediaControlSuccess
= 'Legacy.BluetoothNetwork.MediaControlSuccess'¶
-
Legacy_BluetoothNetwork_ScanDevicesReport
= 'Legacy.BluetoothNetwork.ScanDevicesReport'¶
-
Legacy_BluetoothNetwork_SetDeviceCategoriesFailed
= 'Legacy.BluetoothNetwork.SetDeviceCategoriesFailed'¶
-
Legacy_BluetoothNetwork_SetDeviceCategoriesSucceeded
= 'Legacy.BluetoothNetwork.SetDeviceCategoriesSucceeded'¶
-
Legacy_ContentManager_ContentPlaybackTerminated
= 'Legacy.ContentManager.ContentPlaybackTerminated'¶
-
Legacy_DeviceNotification_DeleteNotificationFailed
= 'Legacy.DeviceNotification.DeleteNotificationFailed'¶
-
Legacy_DeviceNotification_DeleteNotificationSucceeded
= 'Legacy.DeviceNotification.DeleteNotificationSucceeded'¶
-
Legacy_DeviceNotification_NotificationEnteredBackground
= 'Legacy.DeviceNotification.NotificationEnteredBackground'¶
-
Legacy_DeviceNotification_NotificationEnteredForground
= 'Legacy.DeviceNotification.NotificationEnteredForground'¶
-
Legacy_DeviceNotification_NotificationStarted
= 'Legacy.DeviceNotification.NotificationStarted'¶
-
Legacy_DeviceNotification_NotificationStopped
= 'Legacy.DeviceNotification.NotificationStopped'¶
-
Legacy_DeviceNotification_NotificationSync
= 'Legacy.DeviceNotification.NotificationSync'¶
-
Legacy_DeviceNotification_SetNotificationFailed
= 'Legacy.DeviceNotification.SetNotificationFailed'¶
-
Legacy_DeviceNotification_SetNotificationSucceeded
= 'Legacy.DeviceNotification.SetNotificationSucceeded'¶
-
Legacy_EqualizerController_EqualizerChanged
= 'Legacy.EqualizerController.EqualizerChanged'¶
-
Legacy_ExternalMediaPlayer_AuthorizationComplete
= 'Legacy.ExternalMediaPlayer.AuthorizationComplete'¶
-
Legacy_ExternalMediaPlayer_Error
= 'Legacy.ExternalMediaPlayer.Error'¶
-
Legacy_ExternalMediaPlayer_Event
= 'Legacy.ExternalMediaPlayer.Event'¶
-
Legacy_ExternalMediaPlayer_Login
= 'Legacy.ExternalMediaPlayer.Login'¶
-
Legacy_ExternalMediaPlayer_Logout
= 'Legacy.ExternalMediaPlayer.Logout'¶
-
Legacy_ExternalMediaPlayer_ReportDiscoveredPlayers
= 'Legacy.ExternalMediaPlayer.ReportDiscoveredPlayers'¶
-
Legacy_ExternalMediaPlayer_RequestToken
= 'Legacy.ExternalMediaPlayer.RequestToken'¶
-
Legacy_FavoritesController_Error
= 'Legacy.FavoritesController.Error'¶
-
Legacy_FavoritesController_Response
= 'Legacy.FavoritesController.Response'¶
-
Legacy_GameEngine_GameInputEvent
= 'Legacy.GameEngine.GameInputEvent'¶
-
Legacy_HomeAutoWifiController_DeviceReconnected
= 'Legacy.HomeAutoWifiController.DeviceReconnected'¶
-
Legacy_HomeAutoWifiController_HttpNotified
= 'Legacy.HomeAutoWifiController.HttpNotified'¶
-
Legacy_HomeAutoWifiController_SsdpDiscoveryFinished
= 'Legacy.HomeAutoWifiController.SsdpDiscoveryFinished'¶
-
Legacy_HomeAutoWifiController_SsdpServiceDiscovered
= 'Legacy.HomeAutoWifiController.SsdpServiceDiscovered'¶
-
Legacy_HomeAutoWifiController_SsdpServiceTerminated
= 'Legacy.HomeAutoWifiController.SsdpServiceTerminated'¶
-
Legacy_ListModel_AddItemRequest
= 'Legacy.ListModel.AddItemRequest'¶
-
Legacy_ListModel_DeleteItemRequest
= 'Legacy.ListModel.DeleteItemRequest'¶
-
Legacy_ListModel_GetPageByOrdinalRequest
= 'Legacy.ListModel.GetPageByOrdinalRequest'¶
-
Legacy_ListModel_GetPageByTokenRequest
= 'Legacy.ListModel.GetPageByTokenRequest'¶
-
Legacy_ListModel_ListStateUpdateRequest
= 'Legacy.ListModel.ListStateUpdateRequest'¶
-
Legacy_ListModel_UpdateItemRequest
= 'Legacy.ListModel.UpdateItemRequest'¶
-
Legacy_ListRenderer_GetListPageByOrdinal
= 'Legacy.ListRenderer.GetListPageByOrdinal'¶
-
Legacy_ListRenderer_GetListPageByToken
= 'Legacy.ListRenderer.GetListPageByToken'¶
-
Legacy_ListRenderer_ListItemEvent
= 'Legacy.ListRenderer.ListItemEvent'¶
-
Legacy_MediaGrouping_GroupChangeNotificationEvent
= 'Legacy.MediaGrouping.GroupChangeNotificationEvent'¶
-
Legacy_MediaGrouping_GroupChangeResponseEvent
= 'Legacy.MediaGrouping.GroupChangeResponseEvent'¶
-
Legacy_MediaGrouping_GroupSyncEvent
= 'Legacy.MediaGrouping.GroupSyncEvent'¶
-
Legacy_MediaPlayer_PlaybackError
= 'Legacy.MediaPlayer.PlaybackError'¶
-
Legacy_MediaPlayer_PlaybackFinished
= 'Legacy.MediaPlayer.PlaybackFinished'¶
-
Legacy_MediaPlayer_PlaybackIdle
= 'Legacy.MediaPlayer.PlaybackIdle'¶
-
Legacy_MediaPlayer_PlaybackNearlyFinished
= 'Legacy.MediaPlayer.PlaybackNearlyFinished'¶
-
Legacy_MediaPlayer_PlaybackPaused
= 'Legacy.MediaPlayer.PlaybackPaused'¶
-
Legacy_MediaPlayer_PlaybackResumed
= 'Legacy.MediaPlayer.PlaybackResumed'¶
-
Legacy_MediaPlayer_PlaybackStarted
= 'Legacy.MediaPlayer.PlaybackStarted'¶
-
Legacy_MediaPlayer_PlaybackStopped
= 'Legacy.MediaPlayer.PlaybackStopped'¶
-
Legacy_MediaPlayer_SequenceItemsRequested
= 'Legacy.MediaPlayer.SequenceItemsRequested'¶
-
Legacy_MediaPlayer_SequenceModified
= 'Legacy.MediaPlayer.SequenceModified'¶
-
Legacy_MeetingClientController_Event
= 'Legacy.MeetingClientController.Event'¶
-
Legacy_Microphone_AudioRecording
= 'Legacy.Microphone.AudioRecording'¶
-
Legacy_PhoneCallController_Event
= 'Legacy.PhoneCallController.Event'¶
-
Legacy_PlaybackController_ButtonCommand
= 'Legacy.PlaybackController.ButtonCommand'¶
-
Legacy_PlaybackController_LyricsViewedEvent
= 'Legacy.PlaybackController.LyricsViewedEvent'¶
-
Legacy_PlaybackController_NextCommand
= 'Legacy.PlaybackController.NextCommand'¶
-
Legacy_PlaybackController_PauseCommand
= 'Legacy.PlaybackController.PauseCommand'¶
-
Legacy_PlaybackController_PlayCommand
= 'Legacy.PlaybackController.PlayCommand'¶
-
Legacy_PlaybackController_PreviousCommand
= 'Legacy.PlaybackController.PreviousCommand'¶
-
Legacy_PlaybackController_ToggleCommand
= 'Legacy.PlaybackController.ToggleCommand'¶
-
Legacy_PlaylistController_ErrorResponse
= 'Legacy.PlaylistController.ErrorResponse'¶
-
Legacy_PlaylistController_Response
= 'Legacy.PlaylistController.Response'¶
-
Legacy_Presentation_PresentationDismissedEvent
= 'Legacy.Presentation.PresentationDismissedEvent'¶
-
Legacy_Presentation_PresentationUserEvent
= 'Legacy.Presentation.PresentationUserEvent'¶
-
Legacy_SconeRemoteControl_Next
= 'Legacy.SconeRemoteControl.Next'¶
-
Legacy_SconeRemoteControl_PlayPause
= 'Legacy.SconeRemoteControl.PlayPause'¶
-
Legacy_SconeRemoteControl_Previous
= 'Legacy.SconeRemoteControl.Previous'¶
-
Legacy_SconeRemoteControl_VolumeDown
= 'Legacy.SconeRemoteControl.VolumeDown'¶
-
Legacy_SconeRemoteControl_VolumeUp
= 'Legacy.SconeRemoteControl.VolumeUp'¶
-
Legacy_SipClient_Event
= 'Legacy.SipClient.Event'¶
-
Legacy_SoftwareUpdate_CheckSoftwareUpdateReport
= 'Legacy.SoftwareUpdate.CheckSoftwareUpdateReport'¶
-
Legacy_SoftwareUpdate_InitiateSoftwareUpdateReport
= 'Legacy.SoftwareUpdate.InitiateSoftwareUpdateReport'¶
-
Legacy_Speaker_MuteChanged
= 'Legacy.Speaker.MuteChanged'¶
-
Legacy_Speaker_VolumeChanged
= 'Legacy.Speaker.VolumeChanged'¶
-
Legacy_SpeechRecognizer_WakeWordChanged
= 'Legacy.SpeechRecognizer.WakeWordChanged'¶
-
Legacy_SpeechSynthesizer_SpeechFinished
= 'Legacy.SpeechSynthesizer.SpeechFinished'¶
-
Legacy_SpeechSynthesizer_SpeechInterrupted
= 'Legacy.SpeechSynthesizer.SpeechInterrupted'¶
-
Legacy_SpeechSynthesizer_SpeechStarted
= 'Legacy.SpeechSynthesizer.SpeechStarted'¶
-
Legacy_SpeechSynthesizer_SpeechSynthesizerError
= 'Legacy.SpeechSynthesizer.SpeechSynthesizerError'¶
-
Legacy_Spotify_Event
= 'Legacy.Spotify.Event'¶
-
Legacy_System_UserInactivity
= 'Legacy.System.UserInactivity'¶
-
Legacy_UDPController_BroadcastResponse
= 'Legacy.UDPController.BroadcastResponse'¶
-
LocalApplication_AlexaNotifications_Event
= 'LocalApplication.AlexaNotifications.Event'¶
-
LocalApplication_AlexaPlatformTestSpeechlet_Event
= 'LocalApplication.AlexaPlatformTestSpeechlet.Event'¶
-
LocalApplication_AlexaVision_Event
= 'LocalApplication.AlexaVision.Event'¶
-
LocalApplication_AlexaVoiceLayer_Event
= 'LocalApplication.AlexaVoiceLayer.Event'¶
-
LocalApplication_Alexa_Translation_LiveTranslation_Event
= 'LocalApplication.Alexa.Translation.LiveTranslation.Event'¶
-
LocalApplication_AvaPhysicalShopping_Event
= 'LocalApplication.AvaPhysicalShopping.Event'¶
-
LocalApplication_Calendar_Event
= 'LocalApplication.Calendar.Event'¶
-
LocalApplication_Closet_Event
= 'LocalApplication.Closet.Event'¶
-
LocalApplication_Communications_Event
= 'LocalApplication.Communications.Event'¶
-
LocalApplication_DeviceMessaging_Event
= 'LocalApplication.DeviceMessaging.Event'¶
-
LocalApplication_DigitalDash_Event
= 'LocalApplication.DigitalDash.Event'¶
-
LocalApplication_FireflyShopping_Event
= 'LocalApplication.FireflyShopping.Event'¶
-
LocalApplication_Gallery_Event
= 'LocalApplication.Gallery.Event'¶
-
LocalApplication_HHOPhotos_Event
= 'LocalApplication.HHOPhotos.Event'¶
-
LocalApplication_HomeAutomationMedia_Event
= 'LocalApplication.HomeAutomationMedia.Event'¶
-
LocalApplication_KnightContacts_Event
= 'LocalApplication.KnightContacts.Event'¶
-
LocalApplication_KnightHomeThingsToTry_Event
= 'LocalApplication.KnightHomeThingsToTry.Event'¶
-
LocalApplication_KnightHome_Event
= 'LocalApplication.KnightHome.Event'¶
-
LocalApplication_LocalMediaPlayer_Event
= 'LocalApplication.LocalMediaPlayer.Event'¶
-
LocalApplication_LocalVoiceUI_Event
= 'LocalApplication.LocalVoiceUI.Event'¶
-
LocalApplication_MShopPurchasing_Event
= 'LocalApplication.MShopPurchasing.Event'¶
-
LocalApplication_MShop_Event
= 'LocalApplication.MShop.Event'¶
-
LocalApplication_NotificationsApp_Event
= 'LocalApplication.NotificationsApp.Event'¶
-
LocalApplication_Photos_Event
= 'LocalApplication.Photos.Event'¶
-
LocalApplication_Sentry_Event
= 'LocalApplication.Sentry.Event'¶
-
LocalApplication_SipClient_Event
= 'LocalApplication.SipClient.Event'¶
-
LocalApplication_SipUserAgent_Event
= 'LocalApplication.SipUserAgent.Event'¶
-
LocalApplication_VideoExperienceService_Event
= 'LocalApplication.VideoExperienceService.Event'¶
-
LocalApplication_WebVideoPlayer_Event
= 'LocalApplication.WebVideoPlayer.Event'¶
-
LocalApplication_todoRenderer_Event
= 'LocalApplication.todoRenderer.Event'¶
-
MessagingController_UpdateConversationsStatus
= 'MessagingController.UpdateConversationsStatus'¶
-
MessagingController_UpdateMessagesStatusRequest
= 'MessagingController.UpdateMessagesStatusRequest'¶
-
MessagingController_UpdateSendMessageStatusRequest
= 'MessagingController.UpdateSendMessageStatusRequest'¶
-
MessagingController_UploadConversations
= 'MessagingController.UploadConversations'¶
-
Messaging_MessageReceived
= 'Messaging.MessageReceived'¶
-
PlaybackController_NextCommandIssued
= 'PlaybackController.NextCommandIssued'¶
-
PlaybackController_PauseCommandIssued
= 'PlaybackController.PauseCommandIssued'¶
-
PlaybackController_PlayCommandIssued
= 'PlaybackController.PlayCommandIssued'¶
-
PlaybackController_PreviousCommandIssued
= 'PlaybackController.PreviousCommandIssued'¶
-
REMINDER_CREATED
= 'REMINDER_CREATED'¶
-
REMINDER_DELETED
= 'REMINDER_DELETED'¶
-
REMINDER_STARTED
= 'REMINDER_STARTED'¶
-
REMINDER_STATUS_CHANGED
= 'REMINDER_STATUS_CHANGED'¶
-
REMINDER_UPDATED
= 'REMINDER_UPDATED'¶
-
SKILL_ACCOUNT_LINKED
= 'SKILL_ACCOUNT_LINKED'¶
-
SKILL_DISABLED
= 'SKILL_DISABLED'¶
-
SKILL_ENABLED
= 'SKILL_ENABLED'¶
-
SKILL_PERMISSION_ACCEPTED
= 'SKILL_PERMISSION_ACCEPTED'¶
-
SKILL_PERMISSION_CHANGED
= 'SKILL_PERMISSION_CHANGED'¶
-
SKILL_PROACTIVE_SUBSCRIPTION_CHANGED
= 'SKILL_PROACTIVE_SUBSCRIPTION_CHANGED'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.event_publications module¶
-
class
ask_smapi_model.v1.skill.manifest.event_publications.
EventPublications
(event_name=None)¶ Bases:
object
Parameters: event_name ((optional) str) – Name of the event to publish. -
attribute_map
= {'event_name': 'eventName'}¶
-
deserialized_types
= {'event_name': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.flash_briefing_apis module¶
-
class
ask_smapi_model.v1.skill.manifest.flash_briefing_apis.
FlashBriefingApis
(locales=None)¶ Bases:
object
Defines the structure for flash briefing api of the skill.
Parameters: locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info.LocalizedFlashBriefingInfo)) – Defines the structure for locale specific flash briefing api information. -
attribute_map
= {'locales': 'locales'}¶
-
deserialized_types
= {'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info.LocalizedFlashBriefingInfo)'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.flash_briefing_content_type module¶
-
class
ask_smapi_model.v1.skill.manifest.flash_briefing_content_type.
FlashBriefingContentType
¶ Bases:
enum.Enum
format of the feed content.
Allowed enum values: [TEXT, AUDIO, AUDIO_AND_VIDEO]
-
AUDIO
= 'AUDIO'¶
-
AUDIO_AND_VIDEO
= 'AUDIO_AND_VIDEO'¶
-
TEXT
= 'TEXT'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.flash_briefing_genre module¶
-
class
ask_smapi_model.v1.skill.manifest.flash_briefing_genre.
FlashBriefingGenre
¶ Bases:
enum.Enum
Type or subject of the content in the feed.
Allowed enum values: [HEADLINE_NEWS, BUSINESS, POLITICS, ENTERTAINMENT, TECHNOLOGY, HUMOR, LIFESTYLE, SPORTS, SCIENCE, HEALTH_AND_FITNESS, ARTS_AND_CULTURE, PRODUCTIVITY_AND_UTILITIES, OTHER]
-
ARTS_AND_CULTURE
= 'ARTS_AND_CULTURE'¶
-
BUSINESS
= 'BUSINESS'¶
-
ENTERTAINMENT
= 'ENTERTAINMENT'¶
-
HEADLINE_NEWS
= 'HEADLINE_NEWS'¶
-
HEALTH_AND_FITNESS
= 'HEALTH_AND_FITNESS'¶
-
HUMOR
= 'HUMOR'¶
-
LIFESTYLE
= 'LIFESTYLE'¶
-
OTHER
= 'OTHER'¶
-
POLITICS
= 'POLITICS'¶
-
PRODUCTIVITY_AND_UTILITIES
= 'PRODUCTIVITY_AND_UTILITIES'¶
-
SCIENCE
= 'SCIENCE'¶
-
SPORTS
= 'SPORTS'¶
-
TECHNOLOGY
= 'TECHNOLOGY'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.flash_briefing_update_frequency module¶
-
class
ask_smapi_model.v1.skill.manifest.flash_briefing_update_frequency.
FlashBriefingUpdateFrequency
¶ Bases:
enum.Enum
Tells how often the feed has new content.
Allowed enum values: [HOURLY, DAILY, WEEKLY, UNKNOWN]
-
DAILY
= 'DAILY'¶
-
HOURLY
= 'HOURLY'¶
-
UNKNOWN
= 'UNKNOWN'¶
-
WEEKLY
= 'WEEKLY'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.gadget_controller_interface module¶
-
class
ask_smapi_model.v1.skill.manifest.gadget_controller_interface.
GadgetControllerInterface
¶ Bases:
ask_smapi_model.v1.skill.manifest.interface.Interface
Skills using Gadget Controller can send directives to Echo Buttons. This is a legacy interface specific to Echo Buttons.
-
attribute_map
= {'object_type': 'type'}¶
-
deserialized_types
= {'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_smapi_model.v1.skill.manifest.gadget_support module¶
-
class
ask_smapi_model.v1.skill.manifest.gadget_support.
GadgetSupport
¶ Bases:
enum.Enum
Specifies if gadget support is required/optional for this skill to work.
Allowed enum values: [REQUIRED, OPTIONAL]
-
OPTIONAL
= 'OPTIONAL'¶
-
REQUIRED
= 'REQUIRED'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.game_engine_interface module¶
-
class
ask_smapi_model.v1.skill.manifest.game_engine_interface.
GameEngineInterface
¶ Bases:
ask_smapi_model.v1.skill.manifest.interface.Interface
-
attribute_map
= {'object_type': 'type'}¶
-
deserialized_types
= {'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_smapi_model.v1.skill.manifest.health_alias module¶
-
class
ask_smapi_model.v1.skill.manifest.health_alias.
HealthAlias
(name=None)¶ Bases:
object
Parameters: name ((optional) str) – Name of alias to use when invoking a health skill. -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'name': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.health_apis module¶
-
class
ask_smapi_model.v1.skill.manifest.health_apis.
HealthApis
(regions=None, endpoint=None, protocol_version=None, interfaces=None)¶ Bases:
object
Defines the structure of health api in the skill manifest.
Parameters: - regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.region.Region)) – Contains an array of the supported <region> Objects.
- endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) –
- protocol_version ((optional) ask_smapi_model.v1.skill.manifest.health_protocol_version.HealthProtocolVersion) –
- interfaces ((optional) ask_smapi_model.v1.skill.manifest.health_interface.HealthInterface) –
-
attribute_map
= {'endpoint': 'endpoint', 'interfaces': 'interfaces', 'protocol_version': 'protocolVersion', 'regions': 'regions'}¶
-
deserialized_types
= {'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint', 'interfaces': 'ask_smapi_model.v1.skill.manifest.health_interface.HealthInterface', 'protocol_version': 'ask_smapi_model.v1.skill.manifest.health_protocol_version.HealthProtocolVersion', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.region.Region)'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.health_interface module¶
-
class
ask_smapi_model.v1.skill.manifest.health_interface.
HealthInterface
(namespace=None, version=None, requests=None, locales=None)¶ Bases:
object
Parameters: - namespace ((optional) str) – Name of the interface.
- version ((optional) ask_smapi_model.v1.skill.manifest.version.Version) –
- requests ((optional) list[ask_smapi_model.v1.skill.manifest.health_request.HealthRequest]) – Defines the details of requests that a health skill is capable of handling.
- locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.localized_health_info.LocalizedHealthInfo)) – Defines the list for health skill locale specific publishing information in the skill manifest.
-
attribute_map
= {'locales': 'locales', 'namespace': 'namespace', 'requests': 'requests', 'version': 'version'}¶
-
deserialized_types
= {'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.localized_health_info.LocalizedHealthInfo)', 'namespace': 'str', 'requests': 'list[ask_smapi_model.v1.skill.manifest.health_request.HealthRequest]', 'version': 'ask_smapi_model.v1.skill.manifest.version.Version'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.health_protocol_version module¶
ask_smapi_model.v1.skill.manifest.health_request module¶
-
class
ask_smapi_model.v1.skill.manifest.health_request.
HealthRequest
(name=None)¶ Bases:
object
Parameters: name ((optional) str) – Defines the name of request, each request has their own payload format. -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'name': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.house_hold_list module¶
-
class
ask_smapi_model.v1.skill.manifest.house_hold_list.
HouseHoldList
¶ Bases:
object
Defines the structure of household list api in the skill manifest.
-
attribute_map
= {}¶
-
deserialized_types
= {}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.interface module¶
-
class
ask_smapi_model.v1.skill.manifest.interface.
Interface
(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.ALEXA_PRESENTATION_APL:ask_smapi_model.v1.skill.manifest.alexa_presentation_apl_interface.AlexaPresentationAplInterface
,CUSTOM_INTERFACE:ask_smapi_model.v1.skill.manifest.custom_interface.CustomInterface
,ALEXA_PRESENTATION_HTML:ask_smapi_model.v1.skill.manifest.alexa_presentation_html_interface.AlexaPresentationHtmlInterface
,RENDER_TEMPLATE:ask_smapi_model.v1.skill.manifest.display_interface.DisplayInterface
,GADGET_CONTROLLER:ask_smapi_model.v1.skill.manifest.gadget_controller_interface.GadgetControllerInterface
,-
attribute_map
= {'object_type': 'type'}¶
-
deserialized_types
= {'object_type': 'str'}¶
-
discriminator_value_class_map
= {'ALEXA_PRESENTATION_APL': 'ask_smapi_model.v1.skill.manifest.alexa_presentation_apl_interface.AlexaPresentationAplInterface', 'ALEXA_PRESENTATION_HTML': 'ask_smapi_model.v1.skill.manifest.alexa_presentation_html_interface.AlexaPresentationHtmlInterface', 'AUDIO_PLAYER': 'ask_smapi_model.v1.skill.manifest.audio_interface.AudioInterface', 'CUSTOM_INTERFACE': 'ask_smapi_model.v1.skill.manifest.custom_interface.CustomInterface', 'GADGET_CONTROLLER': 'ask_smapi_model.v1.skill.manifest.gadget_controller_interface.GadgetControllerInterface', 'GAME_ENGINE': 'ask_smapi_model.v1.skill.manifest.game_engine_interface.GameEngineInterface', 'RENDER_TEMPLATE': 'ask_smapi_model.v1.skill.manifest.display_interface.DisplayInterface', 'VIDEO_APP': 'ask_smapi_model.v1.skill.manifest.video_app_interface.VideoAppInterface'}¶
-
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_smapi_model.v1.skill.manifest.lambda_endpoint module¶
-
class
ask_smapi_model.v1.skill.manifest.lambda_endpoint.
LambdaEndpoint
(uri=None)¶ Bases:
object
Contains the uri field. This sets the global default endpoint.
Parameters: uri ((optional) str) – Amazon Resource Name (ARN) of the skill's Lambda function or HTTPS URL. -
attribute_map
= {'uri': 'uri'}¶
-
deserialized_types
= {'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_smapi_model.v1.skill.manifest.lambda_region module¶
-
class
ask_smapi_model.v1.skill.manifest.lambda_region.
LambdaRegion
(endpoint=None)¶ Bases:
object
Defines the structure of a regional information.
Parameters: endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) – -
attribute_map
= {'endpoint': 'endpoint'}¶
-
deserialized_types
= {'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info module¶
-
class
ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info.
LocalizedFlashBriefingInfo
(feeds=None, custom_error_message=None)¶ Bases:
object
Defines the localized flash briefing api information.
Parameters: - feeds ((optional) list[ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info_items.LocalizedFlashBriefingInfoItems]) – Defines the structure for a feed information in the skill manifest.
- custom_error_message ((optional) str) – Alexa says this to the customer if the skill fails to render the content.
-
attribute_map
= {'custom_error_message': 'customErrorMessage', 'feeds': 'feeds'}¶
-
deserialized_types
= {'custom_error_message': 'str', 'feeds': 'list[ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info_items.LocalizedFlashBriefingInfoItems]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info_items module¶
-
class
ask_smapi_model.v1.skill.manifest.localized_flash_briefing_info_items.
LocalizedFlashBriefingInfoItems
(logical_name=None, name=None, url=None, image_uri=None, content_type=None, genre=None, update_frequency=None, vui_preamble=None, is_default=None)¶ Bases:
object
Parameters: - logical_name ((optional) str) – Logical name of the feed. This is used to signify relation among feeds across different locales. Example If you have "weather" feed in multiple locale then consider naming it "weather_update" and we will make sure to play the right feed if customer changes the language on device.
- name ((optional) str) – Name that identifies this feed.
- url ((optional) str) – Url for the feed
- image_uri ((optional) str) – Uri for the feed image
- content_type ((optional) ask_smapi_model.v1.skill.manifest.flash_briefing_content_type.FlashBriefingContentType) –
- genre ((optional) ask_smapi_model.v1.skill.manifest.flash_briefing_genre.FlashBriefingGenre) –
- update_frequency ((optional) ask_smapi_model.v1.skill.manifest.flash_briefing_update_frequency.FlashBriefingUpdateFrequency) –
- vui_preamble ((optional) str) – A short introduction for the feed that Alexa reads to the customer before the feed contents. Should start with "In" or "From".
- is_default ((optional) bool) – True if this should be the default feed to be enabled when customer enables the skill false otherwise.
-
attribute_map
= {'content_type': 'contentType', 'genre': 'genre', 'image_uri': 'imageUri', 'is_default': 'isDefault', 'logical_name': 'logicalName', 'name': 'name', 'update_frequency': 'updateFrequency', 'url': 'url', 'vui_preamble': 'vuiPreamble'}¶
-
deserialized_types
= {'content_type': 'ask_smapi_model.v1.skill.manifest.flash_briefing_content_type.FlashBriefingContentType', 'genre': 'ask_smapi_model.v1.skill.manifest.flash_briefing_genre.FlashBriefingGenre', 'image_uri': 'str', 'is_default': 'bool', 'logical_name': 'str', 'name': 'str', 'update_frequency': 'ask_smapi_model.v1.skill.manifest.flash_briefing_update_frequency.FlashBriefingUpdateFrequency', 'url': 'str', 'vui_preamble': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.localized_health_info module¶
-
class
ask_smapi_model.v1.skill.manifest.localized_health_info.
LocalizedHealthInfo
(prompt_name=None, aliases=None)¶ Bases:
object
Defines the structure for health skill locale specific publishing information in the skill manifest.
Parameters: - prompt_name ((optional) str) – SSML supported name to use when Alexa renders the health skill name in a prompt to the user.
- aliases ((optional) list[ask_smapi_model.v1.skill.manifest.health_alias.HealthAlias]) – Defines the names to use when a user tries to invoke the health skill.
-
attribute_map
= {'aliases': 'aliases', 'prompt_name': 'promptName'}¶
-
deserialized_types
= {'aliases': 'list[ask_smapi_model.v1.skill.manifest.health_alias.HealthAlias]', 'prompt_name': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.localized_music_info module¶
-
class
ask_smapi_model.v1.skill.manifest.localized_music_info.
LocalizedMusicInfo
(prompt_name=None, aliases=None, features=None, wordmark_logos=None)¶ Bases:
object
Defines the structure of localized music information in the skill manifest.
Parameters: - prompt_name ((optional) str) – Name to be used when Alexa renders the music skill name.
- aliases ((optional) list[ask_smapi_model.v1.skill.manifest.music_alias.MusicAlias]) –
- features ((optional) list[ask_smapi_model.v1.skill.manifest.music_feature.MusicFeature]) –
- wordmark_logos ((optional) list[ask_smapi_model.v1.skill.manifest.music_wordmark.MusicWordmark]) –
-
attribute_map
= {'aliases': 'aliases', 'features': 'features', 'prompt_name': 'promptName', 'wordmark_logos': 'wordmarkLogos'}¶
-
deserialized_types
= {'aliases': 'list[ask_smapi_model.v1.skill.manifest.music_alias.MusicAlias]', 'features': 'list[ask_smapi_model.v1.skill.manifest.music_feature.MusicFeature]', 'prompt_name': 'str', 'wordmark_logos': 'list[ask_smapi_model.v1.skill.manifest.music_wordmark.MusicWordmark]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.manifest_gadget_support module¶
-
class
ask_smapi_model.v1.skill.manifest.manifest_gadget_support.
ManifestGadgetSupport
(requirement=None, min_gadget_buttons=None, max_gadget_buttons=None, num_players_max=None, num_players_min=None)¶ Bases:
object
Defines the structure for gadget buttons support in the skill manifest.
Parameters: - requirement ((optional) ask_smapi_model.v1.skill.manifest.gadget_support.GadgetSupport) –
- min_gadget_buttons ((optional) int) – Minimum number of gadget buttons required.
- max_gadget_buttons ((optional) int) – Maximum number of gadget buttons required.
- num_players_max ((optional) int) – Maximum number of players in the game.
- num_players_min ((optional) int) – Minimum number of players in the game.
-
attribute_map
= {'max_gadget_buttons': 'maxGadgetButtons', 'min_gadget_buttons': 'minGadgetButtons', 'num_players_max': 'numPlayersMax', 'num_players_min': 'numPlayersMin', 'requirement': 'requirement'}¶
-
deserialized_types
= {'max_gadget_buttons': 'int', 'min_gadget_buttons': 'int', 'num_players_max': 'int', 'num_players_min': 'int', 'requirement': 'ask_smapi_model.v1.skill.manifest.gadget_support.GadgetSupport'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.music_alias module¶
-
class
ask_smapi_model.v1.skill.manifest.music_alias.
MusicAlias
(name=None)¶ Bases:
object
Parameters: name ((optional) str) – Alias name to be associated with the music skill. -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'name': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.music_apis module¶
-
class
ask_smapi_model.v1.skill.manifest.music_apis.
MusicApis
(regions=None, endpoint=None, capabilities=None, interfaces=None, locales=None, content_types=None)¶ Bases:
object
Defines the structure of music api in the skill manifest.
Parameters: - regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.lambda_region.LambdaRegion)) – Contains an array of the supported <region> Objects.
- endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) –
- capabilities ((optional) list[ask_smapi_model.v1.skill.manifest.music_capability.MusicCapability]) – Defines the structure of music capabilities information in the skill manifest.
- interfaces ((optional) ask_smapi_model.v1.skill.manifest.music_interfaces.MusicInterfaces) –
- locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.localized_music_info.LocalizedMusicInfo)) – Defines the structure of locale specific music information in the skill manifest.
- content_types ((optional) list[ask_smapi_model.v1.skill.manifest.music_content_type.MusicContentType]) – List of the type of content to be provided by the music skill.
-
attribute_map
= {'capabilities': 'capabilities', 'content_types': 'contentTypes', 'endpoint': 'endpoint', 'interfaces': 'interfaces', 'locales': 'locales', 'regions': 'regions'}¶
-
deserialized_types
= {'capabilities': 'list[ask_smapi_model.v1.skill.manifest.music_capability.MusicCapability]', 'content_types': 'list[ask_smapi_model.v1.skill.manifest.music_content_type.MusicContentType]', 'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint', 'interfaces': 'ask_smapi_model.v1.skill.manifest.music_interfaces.MusicInterfaces', 'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.localized_music_info.LocalizedMusicInfo)', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.lambda_region.LambdaRegion)'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.music_capability module¶
-
class
ask_smapi_model.v1.skill.manifest.music_capability.
MusicCapability
(namespace=None, name=None, version=None)¶ Bases:
object
Parameters: -
attribute_map
= {'name': 'name', 'namespace': 'namespace', 'version': 'version'}¶
-
deserialized_types
= {'name': 'str', 'namespace': 'str', '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_smapi_model.v1.skill.manifest.music_content_name module¶
-
class
ask_smapi_model.v1.skill.manifest.music_content_name.
MusicContentName
¶ Bases:
enum.Enum
Name of the content type that's supported for the music skill.
Allowed enum values: [ON_DEMAND, RADIO, PODCAST]
-
ON_DEMAND
= 'ON_DEMAND'¶
-
PODCAST
= 'PODCAST'¶
-
RADIO
= 'RADIO'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.music_content_type module¶
-
class
ask_smapi_model.v1.skill.manifest.music_content_type.
MusicContentType
(name=None)¶ Bases:
object
Defines the structure for content that can be provided by a music skill.
Parameters: name ((optional) ask_smapi_model.v1.skill.manifest.music_content_name.MusicContentName) – -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'name': 'ask_smapi_model.v1.skill.manifest.music_content_name.MusicContentName'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.music_feature module¶
-
class
ask_smapi_model.v1.skill.manifest.music_feature.
MusicFeature
(name=None)¶ Bases:
object
Parameters: name ((optional) str) – Feature name to be associated with the music skill. -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'name': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.music_interfaces module¶
-
class
ask_smapi_model.v1.skill.manifest.music_interfaces.
MusicInterfaces
(namespace=None, version=None, requests=None)¶ Bases:
object
Parameters: - namespace ((optional) str) – Name of the interface.
- version ((optional) str) – Version of the interface.
- requests ((optional) list[ask_smapi_model.v1.skill.manifest.music_request.MusicRequest]) – Contains a list of requests/messages that skill can handle.
-
attribute_map
= {'namespace': 'namespace', 'requests': 'requests', 'version': 'version'}¶
-
deserialized_types
= {'namespace': 'str', 'requests': 'list[ask_smapi_model.v1.skill.manifest.music_request.MusicRequest]', '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_smapi_model.v1.skill.manifest.music_request module¶
-
class
ask_smapi_model.v1.skill.manifest.music_request.
MusicRequest
(name=None)¶ Bases:
object
Parameters: name ((optional) str) – Name of the request. -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'name': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.music_wordmark module¶
-
class
ask_smapi_model.v1.skill.manifest.music_wordmark.
MusicWordmark
(uri=None)¶ Bases:
object
Parameters: uri ((optional) str) – Wordmark logo to be used by devices with displays. -
attribute_map
= {'uri': 'uri'}¶
-
deserialized_types
= {'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_smapi_model.v1.skill.manifest.permission_items module¶
-
class
ask_smapi_model.v1.skill.manifest.permission_items.
PermissionItems
(name=None)¶ Bases:
object
Parameters: name ((optional) ask_smapi_model.v1.skill.manifest.permission_name.PermissionName) – -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'name': 'ask_smapi_model.v1.skill.manifest.permission_name.PermissionName'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.permission_name module¶
-
class
ask_smapi_model.v1.skill.manifest.permission_name.
PermissionName
¶ Bases:
enum.Enum
Name of the required permission.
Allowed enum values: [payments_autopay_consent, alexa_async_event_write, avs_distributed_audio, alexa_devices_all_address_full_read, alexa_devices_all_address_country_and_postal_code_read, alexa_devices_all_geolocation_read, alexa_health_profile_write, alexa_household_lists_read, alexa_household_lists_write, alexa_personality_explicit_read, alexa_personality_explicit_write, alexa_profile_name_read, alexa_profile_email_read, alexa_profile_mobile_number_read, alexa_profile_given_name_read, alexa_customer_id_read, alexa_person_id_read, alexa_raw_person_id_read, alexa_utterance_id_read, alexa_devices_all_notifications_write, alexa_devices_all_notifications_urgent_write, alexa_alerts_reminders_skill_readwrite, alexa_alerts_timers_skill_readwrite, alexa_skill_cds_monetization, alexa_music_cast, alexa_skill_products_entitlements, alexa_skill_proactive_enablement, alexa_authenticate_2_mandatory, alexa_authenticate_2_optional, alexa_user_experience_guidance_read, alexa_device_id_read, alexa_device_type_read]
-
alexa_alerts_reminders_skill_readwrite
= 'alexa::alerts:reminders:skill:readwrite'¶
-
alexa_alerts_timers_skill_readwrite
= 'alexa::alerts:timers:skill:readwrite'¶
-
alexa_async_event_write
= 'alexa::async_event:write'¶
-
alexa_authenticate_2_mandatory
= 'alexa::authenticate:2:mandatory'¶
-
alexa_authenticate_2_optional
= 'alexa::authenticate:2:optional'¶
-
alexa_customer_id_read
= 'alexa::customer_id:read'¶
-
alexa_device_id_read
= 'alexa::device_id:read'¶
-
alexa_device_type_read
= 'alexa::device_type:read'¶
-
alexa_devices_all_address_country_and_postal_code_read
= 'alexa:devices:all:address:country_and_postal_code:read'¶
-
alexa_devices_all_address_full_read
= 'alexa::devices:all:address:full:read'¶
-
alexa_devices_all_geolocation_read
= 'alexa::devices:all:geolocation:read'¶
-
alexa_devices_all_notifications_urgent_write
= 'alexa::devices:all:notifications:urgent:write'¶
-
alexa_devices_all_notifications_write
= 'alexa::devices:all:notifications:write'¶
-
alexa_health_profile_write
= 'alexa::health:profile:write'¶
-
alexa_household_lists_read
= 'alexa::household:lists:read'¶
-
alexa_household_lists_write
= 'alexa::household:lists:write'¶
-
alexa_music_cast
= 'alexa::music:cast'¶
-
alexa_person_id_read
= 'alexa::person_id:read'¶
-
alexa_personality_explicit_read
= 'alexa::personality:explicit:read'¶
-
alexa_personality_explicit_write
= 'alexa::personality:explicit:write'¶
-
alexa_profile_email_read
= 'alexa::profile:email:read'¶
-
alexa_profile_given_name_read
= 'alexa::profile:given_name:read'¶
-
alexa_profile_mobile_number_read
= 'alexa::profile:mobile_number:read'¶
-
alexa_profile_name_read
= 'alexa::profile:name:read'¶
-
alexa_raw_person_id_read
= 'alexa::raw_person_id:read'¶
-
alexa_skill_cds_monetization
= 'alexa::skill:cds:monetization'¶
-
alexa_skill_proactive_enablement
= 'alexa::skill:proactive_enablement'¶
-
alexa_skill_products_entitlements
= 'alexa::skill:products:entitlements'¶
-
alexa_user_experience_guidance_read
= 'alexa::user_experience_guidance:read'¶
-
alexa_utterance_id_read
= 'alexa::utterance_id:read'¶
-
avs_distributed_audio
= 'avs::distributed_audio'¶
-
payments_autopay_consent
= 'payments:autopay_consent'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.region module¶
-
class
ask_smapi_model.v1.skill.manifest.region.
Region
(endpoint=None)¶ Bases:
object
Defines the structure for regional information.
Parameters: endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) – -
attribute_map
= {'endpoint': 'endpoint'}¶
-
deserialized_types
= {'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.request module¶
-
class
ask_smapi_model.v1.skill.manifest.request.
Request
(name=None)¶ Bases:
object
Parameters: name ((optional) ask_smapi_model.v1.skill.manifest.request_name.RequestName) – -
attribute_map
= {'name': 'name'}¶
-
deserialized_types
= {'name': 'ask_smapi_model.v1.skill.manifest.request_name.RequestName'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.request_name module¶
-
class
ask_smapi_model.v1.skill.manifest.request_name.
RequestName
¶ Bases:
enum.Enum
Name of the request.
Allowed enum values: [Search, Create, Update]
-
Create
= 'Create'¶
-
Search
= 'Search'¶
-
Update
= 'Update'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.skill_manifest module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest.
SkillManifest
(manifest_version=None, publishing_information=None, privacy_and_compliance=None, events=None, permissions=None, apis=None)¶ Bases:
object
Defines the structure for a skill's metadata.
Parameters: - manifest_version ((optional) str) – Version of the skill manifest.
- publishing_information ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_publishing_information.SkillManifestPublishingInformation) –
- privacy_and_compliance ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_privacy_and_compliance.SkillManifestPrivacyAndCompliance) –
- events ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_events.SkillManifestEvents) –
- permissions ((optional) list[ask_smapi_model.v1.skill.manifest.permission_items.PermissionItems]) – Defines the structure for required permissions information in the skill manifest.
- apis ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_apis.SkillManifestApis) –
-
attribute_map
= {'apis': 'apis', 'events': 'events', 'manifest_version': 'manifestVersion', 'permissions': 'permissions', 'privacy_and_compliance': 'privacyAndCompliance', 'publishing_information': 'publishingInformation'}¶
-
deserialized_types
= {'apis': 'ask_smapi_model.v1.skill.manifest.skill_manifest_apis.SkillManifestApis', 'events': 'ask_smapi_model.v1.skill.manifest.skill_manifest_events.SkillManifestEvents', 'manifest_version': 'str', 'permissions': 'list[ask_smapi_model.v1.skill.manifest.permission_items.PermissionItems]', 'privacy_and_compliance': 'ask_smapi_model.v1.skill.manifest.skill_manifest_privacy_and_compliance.SkillManifestPrivacyAndCompliance', 'publishing_information': 'ask_smapi_model.v1.skill.manifest.skill_manifest_publishing_information.SkillManifestPublishingInformation'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.skill_manifest_apis module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest_apis.
SkillManifestApis
(flash_briefing=None, custom=None, smart_home=None, video=None, alexa_for_business=None, health=None, household_list=None, music=None)¶ Bases:
object
Defines the structure for implemented apis information in the skill manifest.
Parameters: - flash_briefing ((optional) ask_smapi_model.v1.skill.manifest.flash_briefing_apis.FlashBriefingApis) –
- custom ((optional) ask_smapi_model.v1.skill.manifest.custom_apis.CustomApis) –
- smart_home ((optional) ask_smapi_model.v1.skill.manifest.smart_home_apis.SmartHomeApis) –
- video ((optional) ask_smapi_model.v1.skill.manifest.video_apis.VideoApis) –
- alexa_for_business ((optional) ask_smapi_model.v1.skill.manifest.alexa_for_business_apis.AlexaForBusinessApis) –
- health ((optional) ask_smapi_model.v1.skill.manifest.health_apis.HealthApis) –
- household_list ((optional) ask_smapi_model.v1.skill.manifest.house_hold_list.HouseHoldList) –
- music ((optional) ask_smapi_model.v1.skill.manifest.music_apis.MusicApis) –
-
attribute_map
= {'alexa_for_business': 'alexaForBusiness', 'custom': 'custom', 'flash_briefing': 'flashBriefing', 'health': 'health', 'household_list': 'householdList', 'music': 'music', 'smart_home': 'smartHome', 'video': 'video'}¶
-
deserialized_types
= {'alexa_for_business': 'ask_smapi_model.v1.skill.manifest.alexa_for_business_apis.AlexaForBusinessApis', 'custom': 'ask_smapi_model.v1.skill.manifest.custom_apis.CustomApis', 'flash_briefing': 'ask_smapi_model.v1.skill.manifest.flash_briefing_apis.FlashBriefingApis', 'health': 'ask_smapi_model.v1.skill.manifest.health_apis.HealthApis', 'household_list': 'ask_smapi_model.v1.skill.manifest.house_hold_list.HouseHoldList', 'music': 'ask_smapi_model.v1.skill.manifest.music_apis.MusicApis', 'smart_home': 'ask_smapi_model.v1.skill.manifest.smart_home_apis.SmartHomeApis', 'video': 'ask_smapi_model.v1.skill.manifest.video_apis.VideoApis'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.skill_manifest_custom_task module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest_custom_task.
SkillManifestCustomTask
(name=None, version=None)¶ Bases:
object
Defines the name and version of the task that the skill wants to handle.
Parameters: -
attribute_map
= {'name': 'name', 'version': 'version'}¶
-
deserialized_types
= {'name': 'str', '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_smapi_model.v1.skill.manifest.skill_manifest_endpoint module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.
SkillManifestEndpoint
(uri=None, ssl_certificate_type=None)¶ Bases:
object
Defines the structure for endpoint information in the skill manifest.
Parameters: - uri ((optional) str) – Amazon Resource Name (ARN) of the skill's Lambda function or HTTPS URL.
- ssl_certificate_type ((optional) ask_smapi_model.v1.skill.manifest.ssl_certificate_type.SSLCertificateType) –
-
attribute_map
= {'ssl_certificate_type': 'sslCertificateType', 'uri': 'uri'}¶
-
deserialized_types
= {'ssl_certificate_type': 'ask_smapi_model.v1.skill.manifest.ssl_certificate_type.SSLCertificateType', '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_smapi_model.v1.skill.manifest.skill_manifest_envelope module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest_envelope.
SkillManifestEnvelope
(manifest=None)¶ Bases:
object
Parameters: manifest ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest.SkillManifest) – -
attribute_map
= {'manifest': 'manifest'}¶
-
deserialized_types
= {'manifest': 'ask_smapi_model.v1.skill.manifest.skill_manifest.SkillManifest'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.skill_manifest_events module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest_events.
SkillManifestEvents
(subscriptions=None, publications=None, regions=None, endpoint=None)¶ Bases:
object
Defines the structure for subscribed events information in the skill manifest.
Parameters: - subscriptions ((optional) list[ask_smapi_model.v1.skill.manifest.event_name.EventName]) – Contains an array of eventName object each of which contains the name of a skill event.
- publications ((optional) list[ask_smapi_model.v1.skill.manifest.event_publications.EventPublications]) –
- regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.region.Region)) – Contains an array of the supported <region> Objects.
- endpoint ((optional) ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint) –
-
attribute_map
= {'endpoint': 'endpoint', 'publications': 'publications', 'regions': 'regions', 'subscriptions': 'subscriptions'}¶
-
deserialized_types
= {'endpoint': 'ask_smapi_model.v1.skill.manifest.skill_manifest_endpoint.SkillManifestEndpoint', 'publications': 'list[ask_smapi_model.v1.skill.manifest.event_publications.EventPublications]', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.region.Region)', 'subscriptions': 'list[ask_smapi_model.v1.skill.manifest.event_name.EventName]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.skill_manifest_localized_privacy_and_compliance module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest_localized_privacy_and_compliance.
SkillManifestLocalizedPrivacyAndCompliance
(privacy_policy_url=None, terms_of_use_url=None)¶ Bases:
object
Defines the structure for locale specific privacy & compliance information in the skill manifest.
Parameters: -
attribute_map
= {'privacy_policy_url': 'privacyPolicyUrl', 'terms_of_use_url': 'termsOfUseUrl'}¶
-
deserialized_types
= {'privacy_policy_url': 'str', 'terms_of_use_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_smapi_model.v1.skill.manifest.skill_manifest_localized_publishing_information module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest_localized_publishing_information.
SkillManifestLocalizedPublishingInformation
(name=None, small_icon_uri=None, large_icon_uri=None, summary=None, description=None, updates_description=None, example_phrases=None, keywords=None)¶ Bases:
object
Defines the structure for locale specific publishing information in the skill manifest.
Parameters: - name ((optional) str) – Name of the skill that is displayed to customers in the Alexa app.
- small_icon_uri ((optional) str) – URL to a small icon for the skill, which is shown in the list of skills (108x108px).
- large_icon_uri ((optional) str) – URL to a large icon that represents this skill (512x512px).
- summary ((optional) str) – Summary description of the skill, which is shown when viewing the list of skills.
- description ((optional) str) – A full description explaining the skill’s core functionality and any prerequisites to using it (such as additional hardware, software, or accounts). For a Flash Briefing skill, you must list the feeds for the skill.
- updates_description ((optional) str) – Updates description of the skill's new features and fixes in the version. Should describe changes in the revisions of the skill.
- example_phrases ((optional) list[str]) – Three example phrases that illustrate how users can invoke your skill. For accuracy, these phrases must come directly from your sample utterances.
- keywords ((optional) list[str]) – Sample keyword phrases that describe the skill.
-
attribute_map
= {'description': 'description', 'example_phrases': 'examplePhrases', 'keywords': 'keywords', 'large_icon_uri': 'largeIconUri', 'name': 'name', 'small_icon_uri': 'smallIconUri', 'summary': 'summary', 'updates_description': 'updatesDescription'}¶
-
deserialized_types
= {'description': 'str', 'example_phrases': 'list[str]', 'keywords': 'list[str]', 'large_icon_uri': 'str', 'name': 'str', 'small_icon_uri': 'str', 'summary': 'str', 'updates_description': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.skill_manifest_privacy_and_compliance module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest_privacy_and_compliance.
SkillManifestPrivacyAndCompliance
(locales=None, allows_purchases=None, uses_personal_info=None, is_child_directed=None, is_export_compliant=None, contains_ads=None, uses_health_info=None)¶ Bases:
object
Defines the structure for privacy & compliance information in the skill manifest.
Parameters: - locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.skill_manifest_localized_privacy_and_compliance.SkillManifestLocalizedPrivacyAndCompliance)) – Defines the structure for locale specific privacy & compliance information in the skill manifest.
- allows_purchases ((optional) bool) – True if the skill allows users to make purchases or spend real money false otherwise.
- uses_personal_info ((optional) bool) – True if the skill collects users' personal information false otherwise.
- is_child_directed ((optional) bool) – True if the skill is directed to or targets children under the age of 13/16 false otherwise.
- is_export_compliant ((optional) bool) – True if it is certified that the skill may be imported to and exported from the United States and all other countries and regions in which Amazon operate its program or in which skill owner have authorized sales to end users (without the need for Amazon to obtain any license or clearance or take any other action) and is in full compliance with all applicable laws and regulations governing imports and export including those applicable to software that makes use of encryption technology.
- contains_ads ((optional) bool) – True if the skill contains advertising false otherwise.
- uses_health_info ((optional) bool) – True if the skill developer is a Covered Entity (CE) or Business Associate (BA) as defined by the Health Insurance Portability And Accountability Act (HIPAA) and the skill requires Amazon to process PHI on their behalf, false otherwise. This is an optional property and treated as false if not set.
-
attribute_map
= {'allows_purchases': 'allowsPurchases', 'contains_ads': 'containsAds', 'is_child_directed': 'isChildDirected', 'is_export_compliant': 'isExportCompliant', 'locales': 'locales', 'uses_health_info': 'usesHealthInfo', 'uses_personal_info': 'usesPersonalInfo'}¶
-
deserialized_types
= {'allows_purchases': 'bool', 'contains_ads': 'bool', 'is_child_directed': 'bool', 'is_export_compliant': 'bool', 'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.skill_manifest_localized_privacy_and_compliance.SkillManifestLocalizedPrivacyAndCompliance)', 'uses_health_info': 'bool', 'uses_personal_info': 'bool'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.skill_manifest_publishing_information module¶
-
class
ask_smapi_model.v1.skill.manifest.skill_manifest_publishing_information.
SkillManifestPublishingInformation
(name=None, description=None, locales=None, is_available_worldwide=None, distribution_mode=None, gadget_support=None, testing_instructions=None, category=None, distribution_countries=None)¶ Bases:
object
Defines the structure for publishing information in the skill manifest.
Parameters: - name ((optional) str) – Name of the skill that is displayed to customers in the Alexa app.
- description ((optional) str) – Description of the skill's purpose and feature and how it works. Should describe any prerequisites like hardware or account requirements and detailed steps for the customer to get started. For Flash Briefing skill list the feeds offered within the skill. Use a conversational tone and correct grammar and punctuation. This description displays to customers on the skill detail card in the Alexa app.
- locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.skill_manifest_localized_publishing_information.SkillManifestLocalizedPublishingInformation)) – Defines the structure for locale specific publishing information in the skill manifest.
- is_available_worldwide ((optional) bool) – True if the skill should be distributed in all countries where Amazon distributes skill false otherwise.
- distribution_mode ((optional) ask_smapi_model.v1.skill.manifest.distribution_mode.DistributionMode) –
- gadget_support ((optional) ask_smapi_model.v1.skill.manifest.manifest_gadget_support.ManifestGadgetSupport) –
- testing_instructions ((optional) str) – Special instructions provided by the developer to test the skill.
- category ((optional) str) – Category that best describes a skill. Indicates the filter category for the skill in the Alexa App.
- distribution_countries ((optional) list[ask_smapi_model.v1.skill.manifest.distribution_countries.DistributionCountries]) – Selected list of countries provided by the skill owner where Amazon can distribute the skill.
-
attribute_map
= {'category': 'category', 'description': 'description', 'distribution_countries': 'distributionCountries', 'distribution_mode': 'distributionMode', 'gadget_support': 'gadgetSupport', 'is_available_worldwide': 'isAvailableWorldwide', 'locales': 'locales', 'name': 'name', 'testing_instructions': 'testingInstructions'}¶
-
deserialized_types
= {'category': 'str', 'description': 'str', 'distribution_countries': 'list[ask_smapi_model.v1.skill.manifest.distribution_countries.DistributionCountries]', 'distribution_mode': 'ask_smapi_model.v1.skill.manifest.distribution_mode.DistributionMode', 'gadget_support': 'ask_smapi_model.v1.skill.manifest.manifest_gadget_support.ManifestGadgetSupport', 'is_available_worldwide': 'bool', 'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.skill_manifest_localized_publishing_information.SkillManifestLocalizedPublishingInformation)', 'name': 'str', 'testing_instructions': 'str'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.smart_home_apis module¶
-
class
ask_smapi_model.v1.skill.manifest.smart_home_apis.
SmartHomeApis
(regions=None, endpoint=None, protocol_version=None)¶ Bases:
object
Defines the structure for smart home api of the skill.
Parameters: - regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.lambda_region.LambdaRegion)) – Contains an array of the supported <region> Objects.
- endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) –
- protocol_version ((optional) ask_smapi_model.v1.skill.manifest.smart_home_protocol.SmartHomeProtocol) –
-
attribute_map
= {'endpoint': 'endpoint', 'protocol_version': 'protocolVersion', 'regions': 'regions'}¶
-
deserialized_types
= {'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint', 'protocol_version': 'ask_smapi_model.v1.skill.manifest.smart_home_protocol.SmartHomeProtocol', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.lambda_region.LambdaRegion)'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.smart_home_protocol module¶
-
class
ask_smapi_model.v1.skill.manifest.smart_home_protocol.
SmartHomeProtocol
¶ Bases:
enum.Enum
Version of the Smart Home API. Default and recommended value is '3'. You may create a skill with version '2' for testing migration to version '3', but a skill submission using version '2' will not be certified.
Allowed enum values: [_1, _2, _2_5, _2_9, _3]
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.ssl_certificate_type module¶
-
class
ask_smapi_model.v1.skill.manifest.ssl_certificate_type.
SSLCertificateType
¶ Bases:
enum.Enum
The SSL certificate type of the skill's HTTPS endpoint. Only valid for HTTPS endpoint not for AWS Lambda ARN.
Allowed enum values: [SelfSigned, Wildcard, Trusted]
-
SelfSigned
= 'SelfSigned'¶
-
Trusted
= 'Trusted'¶
-
Wildcard
= 'Wildcard'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.up_channel_items module¶
-
class
ask_smapi_model.v1.skill.manifest.up_channel_items.
UpChannelItems
(object_type=None, uri=None)¶ Bases:
object
Parameters: -
attribute_map
= {'object_type': 'type', 'uri': 'uri'}¶
-
deserialized_types
= {'object_type': 'str', '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_smapi_model.v1.skill.manifest.version module¶
ask_smapi_model.v1.skill.manifest.video_apis module¶
-
class
ask_smapi_model.v1.skill.manifest.video_apis.
VideoApis
(regions=None, locales=None, endpoint=None, countries=None)¶ Bases:
object
Defines the structure for video api of the skill.
Parameters: - regions ((optional) dict(str, ask_smapi_model.v1.skill.manifest.video_region.VideoRegion)) – Defines the structure for region information.
- locales ((optional) dict(str, ask_smapi_model.v1.skill.manifest.video_apis_locale.VideoApisLocale)) – Defines the structure for the locale specific video api information.
- endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) –
- countries ((optional) dict(str, ask_smapi_model.v1.skill.manifest.video_country_info.VideoCountryInfo)) – Object that contains <country> Objects for each supported country.
-
attribute_map
= {'countries': 'countries', 'endpoint': 'endpoint', 'locales': 'locales', 'regions': 'regions'}¶
-
deserialized_types
= {'countries': 'dict(str, ask_smapi_model.v1.skill.manifest.video_country_info.VideoCountryInfo)', 'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint', 'locales': 'dict(str, ask_smapi_model.v1.skill.manifest.video_apis_locale.VideoApisLocale)', 'regions': 'dict(str, ask_smapi_model.v1.skill.manifest.video_region.VideoRegion)'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.video_apis_locale module¶
-
class
ask_smapi_model.v1.skill.manifest.video_apis_locale.
VideoApisLocale
(video_provider_targeting_names=None, video_provider_logo_uri=None, catalog_information=None)¶ Bases:
object
Defines the structure for localized video api information.
Parameters: - video_provider_targeting_names ((optional) list[str]) – Defines the video provider's targeting name.
- video_provider_logo_uri ((optional) str) –
- catalog_information ((optional) list[ask_smapi_model.v1.skill.manifest.video_catalog_info.VideoCatalogInfo]) –
-
attribute_map
= {'catalog_information': 'catalogInformation', 'video_provider_logo_uri': 'videoProviderLogoUri', 'video_provider_targeting_names': 'videoProviderTargetingNames'}¶
-
deserialized_types
= {'catalog_information': 'list[ask_smapi_model.v1.skill.manifest.video_catalog_info.VideoCatalogInfo]', 'video_provider_logo_uri': 'str', 'video_provider_targeting_names': 'list[str]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.video_app_interface module¶
-
class
ask_smapi_model.v1.skill.manifest.video_app_interface.
VideoAppInterface
¶ Bases:
ask_smapi_model.v1.skill.manifest.interface.Interface
-
attribute_map
= {'object_type': 'type'}¶
-
deserialized_types
= {'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_smapi_model.v1.skill.manifest.video_catalog_info module¶
-
class
ask_smapi_model.v1.skill.manifest.video_catalog_info.
VideoCatalogInfo
(source_id=None)¶ Bases:
object
Parameters: source_id ((optional) str) – -
attribute_map
= {'source_id': 'sourceId'}¶
-
deserialized_types
= {'source_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_smapi_model.v1.skill.manifest.video_country_info module¶
-
class
ask_smapi_model.v1.skill.manifest.video_country_info.
VideoCountryInfo
(catalog_information=None)¶ Bases:
object
Defines the structure of per-country video info in the skill manifest.
Parameters: catalog_information ((optional) list[ask_smapi_model.v1.skill.manifest.video_catalog_info.VideoCatalogInfo]) – -
attribute_map
= {'catalog_information': 'catalogInformation'}¶
-
deserialized_types
= {'catalog_information': 'list[ask_smapi_model.v1.skill.manifest.video_catalog_info.VideoCatalogInfo]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.video_region module¶
-
class
ask_smapi_model.v1.skill.manifest.video_region.
VideoRegion
(endpoint=None, upchannel=None)¶ Bases:
object
Defines the structure for endpoint information.
Parameters: - endpoint ((optional) ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint) –
- upchannel ((optional) list[ask_smapi_model.v1.skill.manifest.up_channel_items.UpChannelItems]) – The channel through which the partner skill can communicate to Alexa.
-
attribute_map
= {'endpoint': 'endpoint', 'upchannel': 'upchannel'}¶
-
deserialized_types
= {'endpoint': 'ask_smapi_model.v1.skill.manifest.lambda_endpoint.LambdaEndpoint', 'upchannel': 'list[ask_smapi_model.v1.skill.manifest.up_channel_items.UpChannelItems]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_smapi_model.v1.skill.manifest.viewport_mode module¶
-
class
ask_smapi_model.v1.skill.manifest.viewport_mode.
ViewportMode
¶ Bases:
enum.Enum
Defines the mode of viewport that comply with this specification. E.g. HUB TV.
Allowed enum values: [HUB, TV]
-
HUB
= 'HUB'¶
-
TV
= 'TV'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.viewport_shape module¶
-
class
ask_smapi_model.v1.skill.manifest.viewport_shape.
ViewportShape
¶ Bases:
enum.Enum
Defines the shape of the device's viewport.
Allowed enum values: [RECTANGLE, ROUND]
-
RECTANGLE
= 'RECTANGLE'¶
-
ROUND
= 'ROUND'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.manifest.viewport_specification module¶
-
class
ask_smapi_model.v1.skill.manifest.viewport_specification.
ViewportSpecification
(mode=None, shape=None, min_width=None, max_width=None, min_height=None, max_height=None)¶ Bases:
object
Defines a viewport specification.
Parameters: - mode ((optional) ask_smapi_model.v1.skill.manifest.viewport_mode.ViewportMode) –
- shape ((optional) ask_smapi_model.v1.skill.manifest.viewport_shape.ViewportShape) –
- min_width ((optional) int) – Defines the minimum width of viewport that comply with this specification.
- max_width ((optional) int) – Defines the maximum width of viewport that comply with this specification.
- min_height ((optional) int) – Defines the minimum height of viewport that comply with this specification.
- max_height ((optional) int) – Defines the maximum height of viewport that comply with this specification.
-
attribute_map
= {'max_height': 'maxHeight', 'max_width': 'maxWidth', 'min_height': 'minHeight', 'min_width': 'minWidth', 'mode': 'mode', 'shape': 'shape'}¶
-
deserialized_types
= {'max_height': 'int', 'max_width': 'int', 'min_height': 'int', 'min_width': 'int', 'mode': 'ask_smapi_model.v1.skill.manifest.viewport_mode.ViewportMode', 'shape': 'ask_smapi_model.v1.skill.manifest.viewport_shape.ViewportShape'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model