Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateIosChannelResult

The configuration for an iOS channel.

Properties

Optional botId

botId: undefined | string

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

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 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.

isClientAuthenticationEnabled

isClientAuthenticationEnabled: boolean

Whether client authentication is enabled or not.

lifecycleState

lifecycleState: LifecycleState

The Channel's current state.

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.

secretKey

secretKey: string

The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key.

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 = "IOS"

Methods

getDeserializedJsonObj

getJsonObj