CreateCortanaChannelDetails¶
- class oci.oda.models.CreateCortanaChannelDetails(**kwargs)¶
Bases:
CreateChannelDetailsProperties required to create a Cortana channel.
Attributes:
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
A constant which can be used with the type property of a CreateChannelDetails.
Gets the bot_id of this CreateCortanaChannelDetails.
Gets the defined_tags of this CreateChannelDetails.
Gets the description of this CreateChannelDetails.
Gets the freeform_tags of this CreateChannelDetails.
[Required] Gets the msa_app_id of this CreateCortanaChannelDetails.
[Required] Gets the msa_app_password of this CreateCortanaChannelDetails.
[Required] Gets the name of this CreateChannelDetails.
Gets the session_expiry_duration_in_milliseconds of this CreateChannelDetails.
[Required] Gets the type of this CreateChannelDetails.
Methods:
__init__(**kwargs)Initializes a new CreateCortanaChannelDetails 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 CreateChannelDetails. This constant has a value of “ANDROID”
- TYPE_APPEVENT = 'APPEVENT'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “APPEVENT”
- TYPE_APPLICATION = 'APPLICATION'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “APPLICATION”
- TYPE_CORTANA = 'CORTANA'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “CORTANA”
- TYPE_FACEBOOK = 'FACEBOOK'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “FACEBOOK”
- TYPE_IOS = 'IOS'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “IOS”
- TYPE_MSTEAMS = 'MSTEAMS'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “MSTEAMS”
- TYPE_OSS = 'OSS'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “OSS”
- TYPE_OSVC = 'OSVC'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “OSVC”
- TYPE_SERVICECLOUD = 'SERVICECLOUD'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “SERVICECLOUD”
- TYPE_SLACK = 'SLACK'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “SLACK”
- TYPE_TEST = 'TEST'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “TEST”
- TYPE_TWILIO = 'TWILIO'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “TWILIO”
- TYPE_WEB = 'WEB'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “WEB”
- TYPE_WEBHOOK = 'WEBHOOK'¶
A constant which can be used with the type property of a CreateChannelDetails. This constant has a value of “WEBHOOK”
- __init__(**kwargs)¶
Initializes a new CreateCortanaChannelDetails object with values from keyword arguments. The default value of the
typeattribute of this class isCORTANAand 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 CreateCortanaChannelDetails.
description (str) – The value to assign to the description property of this CreateCortanaChannelDetails.
type (str) – The value to assign to the type property of this CreateCortanaChannelDetails. 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 CreateCortanaChannelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateCortanaChannelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateCortanaChannelDetails.
msa_app_id (str) – The value to assign to the msa_app_id property of this CreateCortanaChannelDetails.
msa_app_password (str) – The value to assign to the msa_app_password property of this CreateCortanaChannelDetails.
bot_id (str) – The value to assign to the bot_id property of this CreateCortanaChannelDetails.
- property bot_id¶
Gets the bot_id of this CreateCortanaChannelDetails. The ID of the Skill or Digital Assistant that the Channel is routed to.
- Returns
The bot_id of this CreateCortanaChannelDetails.
- Return type
str
- property 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))
- property description¶
Gets the description of this CreateChannelDetails. A short description of the Channel.
- Returns
The description of this CreateChannelDetails.
- Return type
str
- property 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.
- property msa_app_id¶
[Required] Gets the msa_app_id of this CreateCortanaChannelDetails. The Microsoft App ID that you obtained when you created your bot registration in Azure.
- Returns
The msa_app_id of this CreateCortanaChannelDetails.
- Return type
str
- property msa_app_password¶
[Required] Gets the msa_app_password of this CreateCortanaChannelDetails. The client secret that you obtained from your bot registration.
- Returns
The msa_app_password of this CreateCortanaChannelDetails.
- Return type
str
- property 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
- property 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
- property 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