com.oracle.bmc.oda.model

Class ServiceCloudChannel

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.oda.model.Channel

com.oracle.bmc.oda.model.ServiceCloudChannel

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public final class ServiceCloudChannel
extends Channel

The configuration for a Service Cloud agent channel.
Note: Objects should always be created or deserialized using the ServiceCloudChannel.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ServiceCloudChannel.Builder, which maintain a set of all explicitly set fields called ServiceCloudChannel.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceCloudChannel.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
ServiceCloudChannel(String id, String name, String description, ChannelCategory category, Long sessionExpiryDurationInMilliseconds, LifecycleState lifecycleState, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String domainName, String hostNamePrefix, String userName, ServiceCloudClientType clientType) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ServiceCloudChannel.Builder	builder() Create a new builder.
boolean	equals(Object o)
ServiceCloudClientType	getClientType() The type of Service Cloud client.
String	getDomainName() The domain name.
String	getHostNamePrefix() The host prefix.
String	getUserName() The user name for an Oracle B2C Service staff member who has the necessary profile permissions.
int	hashCode()
ServiceCloudChannel.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.oda.model.Channel

getCategory, getDefinedTags, getDescription, getFreeformTags, getId, getLifecycleState, getName, getSessionExpiryDurationInMilliseconds, getTimeCreated, getTimeUpdated

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ServiceCloudChannel

@Deprecated
public ServiceCloudChannel(String id,
                                       String name,
                                       String description,
                                       ChannelCategory category,
                                       Long sessionExpiryDurationInMilliseconds,
                                       LifecycleState lifecycleState,
                                       Date timeCreated,
                                       Date timeUpdated,
                                       Map<String,String> freeformTags,
                                       Map<String,Map<String,Object>> definedTags,
                                       String domainName,
                                       String hostNamePrefix,
                                       String userName,
                                       ServiceCloudClientType clientType)

Deprecated.

Method Detail

builder

public static ServiceCloudChannel.Builder builder()

Create a new builder.

toBuilder

public ServiceCloudChannel.Builder toBuilder()

getDomainName

public String getDomainName()

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.

Returns:

the value

getHostNamePrefix

public String getHostNamePrefix()

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.

Returns:

the value

getUserName

public String getUserName()

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

Returns:

the value

getClientType

public ServiceCloudClientType getClientType()

The type of Service Cloud client.

Returns:

the value

toString

public String toString()

Overrides:

toString in class Channel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class Channel

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class Channel

hashCode

public int hashCode()

Overrides:

hashCode in class Channel