Show / Hide Table of Contents

Class ServiceCloudChannel

The configuration for a Service Cloud agent channel.

Inheritance
object
Channel
ServiceCloudChannel
Inherited Members
Channel.Id
Channel.Name
Channel.Description
Channel.Category
Channel.SessionExpiryDurationInMilliseconds
Channel.LifecycleState
Channel.TimeCreated
Channel.TimeUpdated
Channel.FreeformTags
Channel.DefinedTags
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.OdaService.Models
Assembly: OCI.DotNetSDK.Oda.dll
Syntax
public class ServiceCloudChannel : Channel

Properties

ClientType

Declaration
[Required(ErrorMessage = "ClientType is required.")]
[JsonProperty(PropertyName = "clientType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ServiceCloudClientType? ClientType { get; set; }
Property Value
Type Description
ServiceCloudClientType?

The type of Service Cloud client.

Remarks

Required

DomainName

Declaration
[Required(ErrorMessage = "DomainName is required.")]
[JsonProperty(PropertyName = "domainName")]
public string DomainName { get; set; }
Property Value
Type Description
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.

Remarks

Required

HostNamePrefix

Declaration
[Required(ErrorMessage = "HostNamePrefix is required.")]
[JsonProperty(PropertyName = "hostNamePrefix")]
public string HostNamePrefix { get; set; }
Property Value
Type Description
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.

Remarks

Required

UserName

Declaration
[Required(ErrorMessage = "UserName is required.")]
[JsonProperty(PropertyName = "userName")]
public string UserName { get; set; }
Property Value
Type Description
string

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

Remarks

Required

In this article
Back to top