CreateChannelDetails¶
-
class
oci.oda.models.CreateChannelDetails(**kwargs)¶ Bases:
objectProperties that are required to create a Channel.
Attributes
TYPE_ANDROIDA constant which can be used with the type property of a CreateChannelDetails. TYPE_APPEVENTA constant which can be used with the type property of a CreateChannelDetails. TYPE_APPLICATIONA constant which can be used with the type property of a CreateChannelDetails. TYPE_CORTANAA constant which can be used with the type property of a CreateChannelDetails. TYPE_FACEBOOKA constant which can be used with the type property of a CreateChannelDetails. TYPE_IOSA constant which can be used with the type property of a CreateChannelDetails. TYPE_MSTEAMSA constant which can be used with the type property of a CreateChannelDetails. TYPE_OSSA constant which can be used with the type property of a CreateChannelDetails. TYPE_OSVCA constant which can be used with the type property of a CreateChannelDetails. TYPE_SERVICECLOUDA constant which can be used with the type property of a CreateChannelDetails. TYPE_SLACKA constant which can be used with the type property of a CreateChannelDetails. TYPE_TESTA constant which can be used with the type property of a CreateChannelDetails. TYPE_TWILIOA constant which can be used with the type property of a CreateChannelDetails. TYPE_WEBA constant which can be used with the type property of a CreateChannelDetails. TYPE_WEBHOOKA constant which can be used with the type property of a CreateChannelDetails. defined_tagsGets the defined_tags of this CreateChannelDetails. descriptionGets the description of this CreateChannelDetails. freeform_tagsGets the freeform_tags of this CreateChannelDetails. name[Required] Gets the name of this CreateChannelDetails. session_expiry_duration_in_millisecondsGets the session_expiry_duration_in_milliseconds of this CreateChannelDetails. type[Required] Gets the type of this CreateChannelDetails. Methods
__init__(**kwargs)Initializes a new CreateChannelDetails 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 CreateChannelDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
CreateMSTeamsChannelDetailsCreateWebChannelDetailsCreateFacebookChannelDetailsCreateApplicationChannelDetailsCreateServiceCloudChannelDetailsCreateSlackChannelDetailsCreateOsvcChannelDetailsCreateAppEventChannelDetailsCreateOSSChannelDetailsCreateCortanaChannelDetailsCreateAndroidChannelDetailsCreateTwilioChannelDetailsCreateWebhookChannelDetailsCreateIosChannelDetails
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 CreateChannelDetails.
- description (str) – The value to assign to the description property of this CreateChannelDetails.
- type (str) – The value to assign to the type property of this CreateChannelDetails. 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 CreateChannelDetails.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateChannelDetails.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateChannelDetails.
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
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.
-
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
-