Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OsvcChannel

The configuration for an OSVC channel.

Properties

authenticationProviderName

authenticationProviderName: string

The name of the Authentication Provider to use to authenticate the user.

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.

channelService

channelService: OsvcServiceType

The type of OSVC service.

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"}}

host

host: string

The host.

For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com.

For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com.

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.

port

port: string

The port.

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.

totalSessionCount

totalSessionCount: number

The total session count. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Const type

type: string = "OSVC"

userName

userName: string

The user name for the digital-assistant agent.

Methods

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Channel): object

getJsonObj