UpdateWebChannelDetails

class oci.oda.models.UpdateWebChannelDetails(**kwargs)

Bases: UpdateChannelDetails

Properties to update a Web channel.

Attributes:

TYPE_ANDROID

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_APPEVENT

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_APPLICATION

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_CORTANA

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_FACEBOOK

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_IOS

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_MSTEAMS

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_OSS

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_OSVC

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_SERVICECLOUD

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_SLACK

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_TEST

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_TWILIO

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_WEB

A constant which can be used with the type property of a UpdateChannelDetails.

TYPE_WEBHOOK

A constant which can be used with the type property of a UpdateChannelDetails.

allowed_domains

Gets the allowed_domains of this UpdateWebChannelDetails.

bot_id

Gets the bot_id of this UpdateWebChannelDetails.

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.

is_client_authentication_enabled

Gets the is_client_authentication_enabled of this UpdateWebChannelDetails.

max_token_expiration_time_in_minutes

Gets the max_token_expiration_time_in_minutes of this UpdateWebChannelDetails.

name

Gets the name of this UpdateChannelDetails.

session_expiry_duration_in_milliseconds

Gets the session_expiry_duration_in_milliseconds of this UpdateChannelDetails.

type

[Required] Gets the type of this UpdateChannelDetails.

Methods:

__init__(**kwargs)

Initializes a new UpdateWebChannelDetails 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.

TYPE_ANDROID = 'ANDROID'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “ANDROID”

TYPE_APPEVENT = 'APPEVENT'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “APPEVENT”

TYPE_APPLICATION = 'APPLICATION'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “APPLICATION”

TYPE_CORTANA = 'CORTANA'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “CORTANA”

TYPE_FACEBOOK = 'FACEBOOK'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “FACEBOOK”

TYPE_IOS = 'IOS'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “IOS”

TYPE_MSTEAMS = 'MSTEAMS'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “MSTEAMS”

TYPE_OSS = 'OSS'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “OSS”

TYPE_OSVC = 'OSVC'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “OSVC”

TYPE_SERVICECLOUD = 'SERVICECLOUD'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “SERVICECLOUD”

TYPE_SLACK = 'SLACK'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “SLACK”

TYPE_TEST = 'TEST'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “TEST”

TYPE_TWILIO = 'TWILIO'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “TWILIO”

TYPE_WEB = 'WEB'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “WEB”

TYPE_WEBHOOK = 'WEBHOOK'

A constant which can be used with the type property of a UpdateChannelDetails. This constant has a value of “WEBHOOK”

__init__(**kwargs)

Initializes a new UpdateWebChannelDetails object with values from keyword arguments. The default value of the type attribute of this class is WEB 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 UpdateWebChannelDetails.

  • description (str) – The value to assign to the description property of this UpdateWebChannelDetails.

  • type (str) – The value to assign to the type property of this UpdateWebChannelDetails. 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 UpdateWebChannelDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateWebChannelDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateWebChannelDetails.

  • max_token_expiration_time_in_minutes (int) – The value to assign to the max_token_expiration_time_in_minutes property of this UpdateWebChannelDetails.

  • is_client_authentication_enabled (bool) – The value to assign to the is_client_authentication_enabled property of this UpdateWebChannelDetails.

  • allowed_domains (str) – The value to assign to the allowed_domains property of this UpdateWebChannelDetails.

  • bot_id (str) – The value to assign to the bot_id property of this UpdateWebChannelDetails.

property allowed_domains

Gets the allowed_domains of this UpdateWebChannelDetails. A comma-delimited whitelist of allowed domains.

The channel will only communicate with the sites from the domains that you add to this list. For example, .corp.example.com, *.hdr.example.com. Entering a single asterisk () allows unrestricted access to the channel from any domain.

Typically, you’d only enter a single asterisk during development. For production, you would add an allowlist of domains.

Returns

The allowed_domains of this UpdateWebChannelDetails.

Return type

str

property bot_id

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

Returns

The bot_id of this UpdateWebChannelDetails.

Return type

str

property 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))

property description

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

Returns

The description of this UpdateChannelDetails.

Return type

str

property 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.

property is_client_authentication_enabled

Gets the is_client_authentication_enabled of this UpdateWebChannelDetails. Whether client authentication is enabled or not.

Returns

The is_client_authentication_enabled of this UpdateWebChannelDetails.

Return type

bool

property max_token_expiration_time_in_minutes

Gets the max_token_expiration_time_in_minutes of this UpdateWebChannelDetails. The maximum time until the token expires (in minutes).

Returns

The max_token_expiration_time_in_minutes of this UpdateWebChannelDetails.

Return type

int

property 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

property 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

property 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