CreateAppEventChannelDetails¶

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

Bases: oci.oda.models.create_channel_details.CreateChannelDetails

Properties required to create an Application Event 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
`defined_tags`	Gets the defined_tags of this CreateChannelDetails.
`description`	Gets the description of this CreateChannelDetails.
`event_sink_bot_ids`	Gets the event_sink_bot_ids of this CreateAppEventChannelDetails.
`freeform_tags`	Gets the freeform_tags of this CreateChannelDetails.
`name`	[Required] Gets the name of this CreateChannelDetails.
`outbound_url`	Gets the outbound_url of this CreateAppEventChannelDetails.
`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 CreateAppEventChannelDetails 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 CreateAppEventChannelDetails object with values from keyword arguments. The default value of the type attribute of this class is APPEVENT 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 CreateAppEventChannelDetails.
description (str) – The value to assign to the description property of this CreateAppEventChannelDetails.
type (str) – The value to assign to the type property of this CreateAppEventChannelDetails. 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 CreateAppEventChannelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateAppEventChannelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateAppEventChannelDetails.
outbound_url (str) – The value to assign to the outbound_url property of this CreateAppEventChannelDetails.
event_sink_bot_ids (list[str]) – The value to assign to the event_sink_bot_ids property of this CreateAppEventChannelDetails.

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

event_sink_bot_ids¶

Gets the event_sink_bot_ids of this CreateAppEventChannelDetails. The IDs of the Skills and Digital Assistants that the Channel is routed to.

Returns:	The event_sink_bot_ids of this CreateAppEventChannelDetails.
Return type:	list[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.

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

outbound_url¶

Gets the outbound_url of this CreateAppEventChannelDetails. The URL for sending errors and responses to.

Returns:	The outbound_url of this CreateAppEventChannelDetails.
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