Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Canvas

Optional. Represents a Interactive Canvas response to be sent to the user.

Represents an Interactive Canvas response to be sent to the user. This can be used in conjunction with the "first_simple" field in the containing prompt to speak to the user in addition to displaying a interactive canvas response. The maximum size of the response is 50k bytes.

A response to be used for interactive canvas experience.

Hierarchy

  • Canvas

Implemented by

Properties

Optional data

data: any[]

Optional. JSON data to be passed through to the immersive experience web page as an event. If the "override" field in the containing prompt is "false" data values defined in this Canvas prompt will be added after data values defined in previous Canvas prompts.

Optional enableFullScreen

enableFullScreen: boolean

If true the canvas application occupies the full screen and won't have a header at the top. A toast message will also be displayed on the loading screen that includes the Action's display name, the developer's name, and instructions for exiting the Action. Default value: false.

Optional suppressMic

suppressMic: boolean

Optional. Default value: false.

Optional url

url: string

URL of the interactive canvas web app to load. If not set, the url from current active canvas will be reused.

Generated using TypeDoc