Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AppEventChannel

The configuration for an Application Event channel.

Properties

category

category: ChannelCategory

The category of the Channel.

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 eventSinkBotIds

eventSinkBotIds: Array<string>

The IDs of the Skills and Digital Assistants that the Channel is routed to.

Optional freeformTags

freeformTags: undefined | object

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

id

id: string

Unique immutable identifier that was assigned when the Channel was created.

lifecycleState

lifecycleState: LifecycleState

The Channel's current state.

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 outboundUrl

outboundUrl: undefined | string

The URL for sending errors and responses to.

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.

timeCreated

timeCreated: Date

When the resource was created. A date-time string as described in RFC 3339, section 14.29.

timeUpdated

timeUpdated: Date

When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

Const type

type: string = "APPEVENT"

webhookUrl

webhookUrl: string

The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.

Methods

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Channel): object

getJsonObj