UpdateOsvcChannelDetails¶

class oci.oda.models.UpdateOsvcChannelDetails(**kwargs)¶

Bases: oci.oda.models.update_channel_details.UpdateChannelDetails

Properties required to update an OSVC channel.

Attributes

`CHANNEL_SERVICE_FUSION`	A constant which can be used with the channel_service property of a UpdateOsvcChannelDetails.
`CHANNEL_SERVICE_OSVC`	A constant which can be used with the channel_service property of a UpdateOsvcChannelDetails.
`TYPE_ANDROID`	str(object=’’) -> str
`TYPE_APPEVENT`	str(object=’’) -> str
`TYPE_APPLICATION`	str(object=’’) -> str
`TYPE_CORTANA`	str(object=’’) -> str
`TYPE_FACEBOOK`	str(object=’’) -> str
`TYPE_IOS`	str(object=’’) -> str
`TYPE_MSTEAMS`	str(object=’’) -> str
`TYPE_OSS`	str(object=’’) -> str
`TYPE_OSVC`	str(object=’’) -> str
`TYPE_SERVICECLOUD`	str(object=’’) -> str
`TYPE_SLACK`	str(object=’’) -> str
`TYPE_TEST`	str(object=’’) -> str
`TYPE_TWILIO`	str(object=’’) -> str
`TYPE_WEB`	str(object=’’) -> str
`TYPE_WEBHOOK`	str(object=’’) -> str
`authentication_provider_name`	Gets the authentication_provider_name of this UpdateOsvcChannelDetails.
`bot_id`	Gets the bot_id of this UpdateOsvcChannelDetails.
`channel_service`	Gets the channel_service of this UpdateOsvcChannelDetails.
`defined_tags`	Gets the defined_tags of this UpdateChannelDetails.
`description`	Gets the description of this UpdateChannelDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateChannelDetails.
`host`	Gets the host of this UpdateOsvcChannelDetails.
`name`	Gets the name of this UpdateChannelDetails.
`password`	Gets the password of this UpdateOsvcChannelDetails.
`port`	Gets the port of this UpdateOsvcChannelDetails.
`session_expiry_duration_in_milliseconds`	Gets the session_expiry_duration_in_milliseconds of this UpdateChannelDetails.
`total_session_count`	Gets the total_session_count of this UpdateOsvcChannelDetails.
`type`	[Required] Gets the type of this UpdateChannelDetails.
`user_name`	Gets the user_name of this UpdateOsvcChannelDetails.

Methods

`__init__`(**kwargs)	Initializes a new UpdateOsvcChannelDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CHANNEL_SERVICE_FUSION = 'FUSION'¶: A constant which can be used with the channel_service property of a UpdateOsvcChannelDetails. This constant has a value of “FUSION”

CHANNEL_SERVICE_OSVC = 'OSVC'¶: A constant which can be used with the channel_service property of a UpdateOsvcChannelDetails. This constant has a value of “OSVC”

TYPE_ANDROID = 'ANDROID'¶

TYPE_APPEVENT = 'APPEVENT'¶

TYPE_APPLICATION = 'APPLICATION'¶

TYPE_CORTANA = 'CORTANA'¶

TYPE_FACEBOOK = 'FACEBOOK'¶

TYPE_IOS = 'IOS'¶

TYPE_MSTEAMS = 'MSTEAMS'¶

TYPE_OSS = 'OSS'¶

TYPE_OSVC = 'OSVC'¶

TYPE_SERVICECLOUD = 'SERVICECLOUD'¶

TYPE_SLACK = 'SLACK'¶

TYPE_TEST = 'TEST'¶

TYPE_TWILIO = 'TWILIO'¶

TYPE_WEB = 'WEB'¶

TYPE_WEBHOOK = 'WEBHOOK'¶

__init__(**kwargs)¶

Initializes a new UpdateOsvcChannelDetails object with values from keyword arguments. The default value of the type attribute of this class is OSVC and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this UpdateOsvcChannelDetails.
description (str) – The value to assign to the description property of this UpdateOsvcChannelDetails.
type (str) – The value to assign to the type property of this UpdateOsvcChannelDetails. Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”
session_expiry_duration_in_milliseconds (int) – The value to assign to the session_expiry_duration_in_milliseconds property of this UpdateOsvcChannelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateOsvcChannelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateOsvcChannelDetails.
host (str) – The value to assign to the host property of this UpdateOsvcChannelDetails.
port (str) – The value to assign to the port property of this UpdateOsvcChannelDetails.
user_name (str) – The value to assign to the user_name property of this UpdateOsvcChannelDetails.
password (str) – The value to assign to the password property of this UpdateOsvcChannelDetails.
total_session_count (int) – The value to assign to the total_session_count property of this UpdateOsvcChannelDetails.
channel_service (str) – The value to assign to the channel_service property of this UpdateOsvcChannelDetails. Allowed values for this property are: “OSVC”, “FUSION”
authentication_provider_name (str) – The value to assign to the authentication_provider_name property of this UpdateOsvcChannelDetails.
bot_id (str) – The value to assign to the bot_id property of this UpdateOsvcChannelDetails.

authentication_provider_name¶

Gets the authentication_provider_name of this UpdateOsvcChannelDetails. The name of the Authentication Provider to use to authenticate the user.

Returns:	The authentication_provider_name of this UpdateOsvcChannelDetails.
Return type:	str

bot_id¶

Gets the bot_id of this UpdateOsvcChannelDetails. The ID of the Skill or Digital Assistant that the Channel is routed to.

Returns:	The bot_id of this UpdateOsvcChannelDetails.
Return type:	str

channel_service¶

Gets the channel_service of this UpdateOsvcChannelDetails. The type of OSVC service.

Allowed values for this property are: “OSVC”, “FUSION”

Returns:	The channel_service of this UpdateOsvcChannelDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this UpdateChannelDetails. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this UpdateChannelDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this UpdateChannelDetails. A short description of the Channel.

Returns:	The description of this UpdateChannelDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this UpdateChannelDetails. Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this UpdateChannelDetails.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

host¶

Gets the host of this UpdateOsvcChannelDetails. 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.

Returns:	The host of this UpdateOsvcChannelDetails.
Return type:	str

name¶

Gets the name of this UpdateChannelDetails. The Channel’s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.

Returns:	The name of this UpdateChannelDetails.
Return type:	str

password¶

Gets the password of this UpdateOsvcChannelDetails. The password for the digital-assistant agent.

Returns:	The password of this UpdateOsvcChannelDetails.
Return type:	str

port¶

Gets the port of this UpdateOsvcChannelDetails. The port.

Returns:	The port of this UpdateOsvcChannelDetails.
Return type:	str

session_expiry_duration_in_milliseconds¶

Gets the session_expiry_duration_in_milliseconds of this UpdateChannelDetails. The number of milliseconds before a session expires.

Returns:	The session_expiry_duration_in_milliseconds of this UpdateChannelDetails.
Return type:	int

total_session_count¶

Gets the total_session_count of this UpdateOsvcChannelDetails. The total session count.

Returns:	The total_session_count of this UpdateOsvcChannelDetails.
Return type:	int

type¶

[Required] Gets the type of this UpdateChannelDetails. The Channel type.

Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”

Returns:	The type of this UpdateChannelDetails.
Return type:	str

user_name¶

Gets the user_name of this UpdateOsvcChannelDetails. The user name for the digital-assistant agent.

Returns:	The user_name of this UpdateOsvcChannelDetails.
Return type:	str