Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateWebChannelDetails

Properties required to create a Web channel.

Properties

Optional allowedDomains

allowedDomains: undefined | string

A comma-delimited whitelist of allowed domains.

The channel will only communicate with the sites from the domains that you add to this list. For example, *.corp.example.com, .hdr.example.com. Entering a single asterisk () allows unrestricted access to the channel from any domain.

Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains.

Optional botId

botId: undefined | string

The ID of the Skill or Digital Assistant that the Channel is routed to.

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

A short description of the Channel.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {@code {"bar-key": "value"}}

isClientAuthenticationEnabled

isClientAuthenticationEnabled: boolean

Whether client authentication is enabled or not.

Optional maxTokenExpirationTimeInMinutes

maxTokenExpirationTimeInMinutes: undefined | number

The maximum time until the token expires (in minutes). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

name

name: string

The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.

Optional sessionExpiryDurationInMilliseconds

sessionExpiryDurationInMilliseconds: undefined | number

The number of milliseconds before a session expires. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Const type

type: string = "WEB"

Methods

getDeserializedJsonObj

getJsonObj