CreateWebChannelDetails¶

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

Bases: oci.oda.models.create_channel_details.CreateChannelDetails

Properties required to create a Web channel.

Attributes

`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
`allowed_domains`	Gets the allowed_domains of this CreateWebChannelDetails.
`bot_id`	Gets the bot_id of this CreateWebChannelDetails.
`defined_tags`	Gets the defined_tags of this CreateChannelDetails.
`description`	Gets the description of this CreateChannelDetails.
`freeform_tags`	Gets the freeform_tags of this CreateChannelDetails.
`is_client_authentication_enabled`	[Required] Gets the is_client_authentication_enabled of this CreateWebChannelDetails.
`max_token_expiration_time_in_minutes`	Gets the max_token_expiration_time_in_minutes of this CreateWebChannelDetails.
`name`	[Required] Gets the name of this CreateChannelDetails.
`session_expiry_duration_in_milliseconds`	Gets the session_expiry_duration_in_milliseconds of this CreateChannelDetails.
`type`	[Required] Gets the type of this CreateChannelDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateWebChannelDetails 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'¶

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 CreateWebChannelDetails 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 CreateWebChannelDetails.
description (str) – The value to assign to the description property of this CreateWebChannelDetails.
type (str) – The value to assign to the type property of this CreateWebChannelDetails. 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 CreateWebChannelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateWebChannelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateWebChannelDetails.
max_token_expiration_time_in_minutes (int) – The value to assign to the max_token_expiration_time_in_minutes property of this CreateWebChannelDetails.
is_client_authentication_enabled (bool) – The value to assign to the is_client_authentication_enabled property of this CreateWebChannelDetails.
allowed_domains (str) – The value to assign to the allowed_domains property of this CreateWebChannelDetails.
bot_id (str) – The value to assign to the bot_id property of this CreateWebChannelDetails.

allowed_domains¶

Gets the allowed_domains of this CreateWebChannelDetails. 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 CreateWebChannelDetails.
Return type:	str

bot_id¶

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

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

defined_tags¶

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

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

description¶

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

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

freeform_tags¶

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

Returns:	The freeform_tags of this CreateChannelDetails.
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.

is_client_authentication_enabled¶

[Required] Gets the is_client_authentication_enabled of this CreateWebChannelDetails. Whether client authentication is enabled or not.

Returns:	The is_client_authentication_enabled of this CreateWebChannelDetails.
Return type:	bool

max_token_expiration_time_in_minutes¶

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

Returns:	The max_token_expiration_time_in_minutes of this CreateWebChannelDetails.
Return type:	int

name¶

[Required] Gets the name of this CreateChannelDetails. 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 CreateChannelDetails.
Return type:	str

session_expiry_duration_in_milliseconds¶

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

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

type¶

[Required] Gets the type of this CreateChannelDetails. 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 CreateChannelDetails.
Return type:	str