Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateServiceCloudChannelDetails

Properties to update a Service Cloud agent channel.

Properties

Optional clientType

clientType: model.ServiceCloudClientType

The type of Service Cloud client.

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 domainName

domainName: undefined | string

The domain name.

If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com.

If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com.

Optional freeformTags

freeformTags: undefined | object

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

Optional hostNamePrefix

hostNamePrefix: undefined | string

The host prefix.

If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com.

If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com.

Optional name

name: undefined | string

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

Optional password

password: undefined | string

The password for the Oracle B2C Service staff member who has the necessary profile permissions.

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

Optional userName

userName: undefined | string

The user name for an Oracle B2C Service staff member who has the necessary profile permissions.

Methods

getDeserializedJsonObj

getJsonObj