UNPKG

@alexa/ask-expressions-spec

Version:

The JSON Schema specification for the Alexa Skills Kit Intermediate Representation (ASKIR).

160 lines (89 loc) 5.39 kB
# name Schema ```txt https://amazonalexa.com/ask/2020/12/InteractionNameDeclaration ``` Introduces a name for an expression. Can only be used in Interaction block. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------------ | | Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [InteractionNameDeclaration.json](../../schemas/InteractionNameDeclaration.json "open original schema") | ## name Type `object` ([name](interactionnamedeclaration.md)) # name Properties | Property | Type | Required | Nullable | Defined by | | :-------------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | | [kind](#kind) | Not specified | Required | cannot be null | [name](interactionnamedeclaration-properties-kind.md "https://amazonalexa.com/ask/2020/12/InteractionNameDeclaration#/properties/kind") | | [name](#name) | `string` | Required | cannot be null | [name](genericargumentsdeclaration-items-properties-name.md "https://amazonalexa.com/ask/2020/12/Name#/properties/name") | | [type](#type) | `object` | Optional | cannot be null | [name](actiondeclaration-properties-typereference.md "https://amazonalexa.com/ask/2020/12/TypeReference#/properties/type") | | [expression](#expression) | Merged | Required | cannot be null | [name](interactionnamedeclaration-properties-expression.md "https://amazonalexa.com/ask/2020/12/InteractionNameDeclaration#/properties/expression") | | [annotations](#annotations) | `array` | Optional | cannot be null | [name](interactionnamedeclaration-properties-annotations.md "https://amazonalexa.com/ask/2020/12/InteractionNameDeclaration#/properties/annotations") | ## kind The expression's identifier. `kind` * is required * Type: unknown ([kind](interactionnamedeclaration-properties-kind.md)) * cannot be null * defined in: [name](interactionnamedeclaration-properties-kind.md "https://amazonalexa.com/ask/2020/12/InteractionNameDeclaration#/properties/kind") ### kind Type unknown ([kind](interactionnamedeclaration-properties-kind.md)) ### kind Constraints **constant**: the value of this property must be equal to: ```json "InteractionNameDeclaration" ``` ## name A name. `name` * is required * Type: `string` ([Name](genericargumentsdeclaration-items-properties-name.md)) * cannot be null * defined in: [name](genericargumentsdeclaration-items-properties-name.md "https://amazonalexa.com/ask/2020/12/Name#/properties/name") ### name Type `string` ([Name](genericargumentsdeclaration-items-properties-name.md)) ### name Constraints **pattern**: the string must match the following regular expression:  ```regexp ^[a-zA-Z_][a-zA-Z0-9_]*$ ``` [try pattern](https://regexr.com/?expression=%5E%5Ba-zA-Z_%5D%5Ba-zA-Z0-9_%5D*%24 "try regular expression with regexr.com") ### name Examples ```json "foo" ``` ```json "bar" ``` ```json "person" ``` ```json "foo1" ``` ## type The representation of a reference to a type declaration. `type` * is optional * Type: `object` ([TypeReference](actiondeclaration-properties-typereference.md)) * cannot be null * defined in: [name](actiondeclaration-properties-typereference.md "https://amazonalexa.com/ask/2020/12/TypeReference#/properties/type") ### type Type `object` ([TypeReference](actiondeclaration-properties-typereference.md)) ## expression `expression` * is required * Type: merged type ([Details](interactionnamedeclaration-properties-expression.md)) * cannot be null * defined in: [name](interactionnamedeclaration-properties-expression.md "https://amazonalexa.com/ask/2020/12/InteractionNameDeclaration#/properties/expression") ### expression Type merged type ([Details](interactionnamedeclaration-properties-expression.md)) one (and only one) of * [Call](actiondeclaration-properties-annotations-call.md "check type definition") * [property reference](arguments-definitions-arg-expression-oneof-property-reference.md "check type definition") * [name](arguments-definitions-arg-expression-oneof-name.md "check type definition") ## annotations `annotations` * is optional * Type: `object[]` ([Call](actiondeclaration-properties-annotations-call.md)) * cannot be null * defined in: [name](interactionnamedeclaration-properties-annotations.md "https://amazonalexa.com/ask/2020/12/InteractionNameDeclaration#/properties/annotations") ### annotations Type `object[]` ([Call](actiondeclaration-properties-annotations-call.md))