Class SkillRequest

Creates a the JSON for a Service Request programmatically

This class assists with setting all the values on the request.

Additionally, the raw JSON can be accessed with the .json() property.

Hierarchy

SkillRequest

Index

Constructors

constructor

Methods

Constructors

constructor

new SkillRequest(alexa: VirtualAlexa): SkillRequest

- Defined in core/SkillRequest.ts:51
Parameters
- alexa: VirtualAlexa
Returns SkillRequest

Methods

audioPlayer

audioPlayer(requestType: string, token: string, offsetInMilliseconds: number): SkillRequest

- Defined in core/SkillRequest.ts:64
Creates an AudioPlayer request type

Parameters
- requestType: string
  
  One the of the AudioPlayer RequestTypes
- token: string
- offsetInMilliseconds: number
Returns SkillRequest

dialogState

dialogState(state: DialogState): SkillRequest

- Defined in core/SkillRequest.ts:75
Sets the dialog state for the request, as well as the internal dialog manager

Parameters
- state: DialogState
  
  The dialog state
Returns SkillRequest

elementSelected

elementSelected(token: any): SkillRequest

- Defined in core/SkillRequest.ts:85
Creates a Display.ElementSelected request

Parameters
- token: any
  
  The token for the selected element
Returns SkillRequest

intent

intent(intentName: string, confirmationStatus?: ConfirmationStatus): SkillRequest

- Defined in core/SkillRequest.ts:96
Sets the intent for the request

Parameters
- intentName: string
- Default value confirmationStatus: ConfirmationStatus = ConfirmationStatus.NONE
Returns SkillRequest

intentStatus

intentStatus(confirmationStatus: ConfirmationStatus): SkillRequest

- Defined in core/SkillRequest.ts:140
Sets the confirmation status of the intent

Parameters
- confirmationStatus: ConfirmationStatus
  
  The confirmation status of the intent
Returns SkillRequest

json

json(): any

- Defined in core/SkillRequest.ts:148
The raw JSON of the request. This can be directly manipulated to modify what is sent to the skill.

Returns any

launch

launch(): SkillRequest

- Defined in core/SkillRequest.ts:155
Creates a LaunchRequest request

Returns SkillRequest

requestType

requestType(requestType: string): SkillRequest

- Defined in core/SkillRequest.ts:171
Parameters
- requestType: string
Returns SkillRequest

requiresSession

requiresSession(): boolean

- Defined in core/SkillRequest.ts:161
internal

Returns boolean

send

send(): Promise<SkillResponse>

- Defined in core/SkillRequest.ts:283
Sends the request to the Alexa skill

Returns Promise<SkillResponse>

sessionEnded

sessionEnded(reason: SessionEndedReason, errorData?: any): SkillRequest

- Defined in core/SkillRequest.ts:230
Creates a SessionEndedRequest request

Parameters
- reason: SessionEndedReason
  
  The reason the session ended
- Optional errorData: any
  
  Error data, if any
Returns SkillRequest

set

set(path: string, value: any): SkillRequest

- Defined in core/SkillRequest.ts:245
Convenience method to set properties on the request object - uses lodash set under the covers. Returns this for chaining

Parameters
- path: string
  
  The dot-notation path for the property to set
- value: any
  
  The value to set it to
Returns SkillRequest

slot

slot(slotName: string, slotValue: string, confirmationStatus?: ConfirmationStatus): SkillRequest

- Defined in core/SkillRequest.ts:256
Sets a slot value on the request

Parameters
- slotName: string
- slotValue: string
- Default value confirmationStatus: ConfirmationStatus = ConfirmationStatus.NONE
Returns SkillRequest

slotStatus

slotStatus(slotName: string, confirmationStatus: ConfirmationStatus): SkillRequest

- Defined in core/SkillRequest.ts:305
For dialogs, updates the confirmation status of a slot - does not change the value

Parameters
- slotName: string
- confirmationStatus: ConfirmationStatus
Returns SkillRequest

slots

slots(slots: object): SkillRequest

- Defined in core/SkillRequest.ts:290
Sets slot values as a dictionary of strings on the request

Parameters
- slots: object
  - [id: string]: string
Returns SkillRequest

Generated using TypeDoc