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.

Hierarchy

  • Canvas

Implemented by

Properties

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 suppressMic

suppressMic: undefined | false | true

Optional. Default value: false.

Optional url

url: undefined | 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