@@ -16,119 +16,144 @@ class Activity(Model):
1616 """An Activity is the basic communication type for the Bot Framework 3.0
1717 protocol.
1818
19- :param type: The type of the activity. Possible values include: 'message',
20- 'contactRelationUpdate ', 'conversationUpdate ', 'typing ', 'ping ',
19+ :param type: Contains the activity type . Possible values include:
20+ 'message ', 'contactRelationUpdate ', 'conversationUpdate ', 'typing ',
2121 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate',
2222 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion',
23- 'trace'
23+ 'trace', 'handoff'
2424 :type type: str or ~botframework.connector.models.ActivityTypes
25- :param id: ID of this activity
25+ :param id: Contains an ID that uniquely identifies the activity on the
26+ channel.
2627 :type id: str
27- :param timestamp: UTC Time when message was sent (set by service)
28+ :param timestamp: Contains the date and time that the message was sent, in
29+ UTC, expressed in ISO-8601 format.
2830 :type timestamp: datetime
29- :param local_timestamp: Local time when message was sent (set by client,
30- Ex: 2016-09-23T13:07:49.4714686-07:00)
31+ :param local_timestamp: Contains the date and time that the message was
32+ sent, in local time, expressed in ISO-8601 format.
33+ For example, 2016-09-23T13:07:49.4714686-07:00.
3134 :type local_timestamp: datetime
32- :param service_url: Service endpoint where operations concerning the
33- activity may be performed
35+ :param local_timezone: Contains the name of the timezone in which the
36+ message, in local time, expressed in IANA Time Zone database format.
37+ For example, America/Los_Angeles.
38+ :type local_timezone: str
39+ :param service_url: Contains the URL that specifies the channel's service
40+ endpoint. Set by the channel.
3441 :type service_url: str
35- :param channel_id: ID of the channel where the activity was sent
42+ :param channel_id: Contains an ID that uniquely identifies the channel.
43+ Set by the channel.
3644 :type channel_id: str
37- :param from_property: Sender address
38- :type from_property: ~botframework.connector.models.ChannelAccount
39- :param conversation: Conversation
45+ :param from: Identifies the sender of the message.
46+ :type from: ~botframework.connector.models.ChannelAccount
47+ :param conversation: Identifies the conversation to which the activity
48+ belongs.
4049 :type conversation: ~botframework.connector.models.ConversationAccount
41- :param recipient: (Outbound to bot only) Bot's address that received the
42- message
50+ :param recipient: Identifies the recipient of the message.
4351 :type recipient: ~botframework.connector.models.ChannelAccount
4452 :param text_format: Format of text fields Default:markdown. Possible
4553 values include: 'markdown', 'plain', 'xml'
4654 :type text_format: str or ~botframework.connector.models.TextFormatTypes
47- :param attachment_layout: Hint for how to deal with multiple attachments.
48- Default:list. Possible values include: 'list', 'carousel'
55+ :param attachment_layout: The layout hint for multiple attachments.
56+ Default: list. Possible values include: 'list', 'carousel'
4957 :type attachment_layout: str or
5058 ~botframework.connector.models.AttachmentLayoutTypes
51- :param members_added: Members added to the conversation
59+ :param members_added: The collection of members added to the conversation.
5260 :type members_added: list[~botframework.connector.models.ChannelAccount]
53- :param members_removed: Members removed from the conversation
61+ :param members_removed: The collection of members removed from the
62+ conversation.
5463 :type members_removed: list[~botframework.connector.models.ChannelAccount]
55- :param reactions_added: Reactions added to the activity
64+ :param reactions_added: The collection of reactions added to the
65+ conversation.
5666 :type reactions_added:
5767 list[~botframework.connector.models.MessageReaction]
58- :param reactions_removed: Reactions removed from the activity
68+ :param reactions_removed: The collection of reactions removed from the
69+ conversation.
5970 :type reactions_removed:
6071 list[~botframework.connector.models.MessageReaction]
61- :param topic_name: The conversation's updated topic name
72+ :param topic_name: The updated topic name of the conversation.
6273 :type topic_name: str
63- :param history_disclosed: True if prior history of the channel is
64- disclosed
74+ :param history_disclosed: Indicates whether the prior history of the
75+ channel is disclosed.
6576 :type history_disclosed: bool
66- :param locale: The language code of the Text field
77+ :param locale: A locale name for the contents of the text field.
78+ The locale name is a combination of an ISO 639 two- or three-letter
79+ culture code associated with a language
80+ and an ISO 3166 two-letter subculture code associated with a country or
81+ region.
82+ The locale name can also correspond to a valid BCP-47 language tag.
6783 :type locale: str
68- :param text: Content for the message
84+ :param text: The text content of the message.
6985 :type text: str
70- :param speak: SSML Speak for TTS audio response
86+ :param speak: The text to speak.
7187 :type speak: str
72- :param input_hint: Input hint to the channel on what the bot is expecting.
73- Possible values include: 'acceptingInput', 'ignoringInput',
88+ :param input_hint: Indicates whether your bot is accepting,
89+ expecting, or ignoring user input after the message is delivered to the
90+ client. Possible values include: 'acceptingInput', 'ignoringInput',
7491 'expectingInput'
7592 :type input_hint: str or ~botframework.connector.models.InputHints
76- :param summary: Text to display if the channel cannot render cards
93+ :param summary: The text to display if the channel cannot render cards.
7794 :type summary: str
78- :param suggested_actions: SuggestedActions are used to provide
79- keyboard/quickreply like behavior in many clients
95+ :param suggested_actions: The suggested actions for the activity.
8096 :type suggested_actions: ~botframework.connector.models.SuggestedActions
8197 :param attachments: Attachments
8298 :type attachments: list[~botframework.connector.models.Attachment]
83- :param entities: Collection of Entity objects, each of which contains
84- metadata about this activity. Each Entity object is typed .
99+ :param entities: Represents the entities that were mentioned in the
100+ message .
85101 :type entities: list[~botframework.connector.models.Entity]
86- :param channel_data: Channel -specific payload
102+ :param channel_data: Contains channel -specific content.
87103 :type channel_data: object
88- :param action: ContactAdded/Removed action
104+ :param action: Indicates whether the recipient of a contactRelationUpdate
105+ was added or removed from the sender's contact list.
89106 :type action: str
90- :param reply_to_id: The original ID this message is a response to
107+ :param reply_to_id: Contains the ID of the message to which this message
108+ is a reply.
91109 :type reply_to_id: str
92- :param label: Descriptive label
110+ :param label: A descriptive label for the activity.
93111 :type label: str
94- :param value_type: Unique string which identifies the shape of the value
95- object
112+ :param value_type: The type of the activity's value object.
96113 :type value_type: str
97- :param value: Open-ended value
114+ :param value: A value that is associated with the activity.
98115 :type value: object
99- :param name: Name of the operation to invoke or the name of the event
116+ :param name: The name of the operation associated with an invoke or event
117+ activity.
100118 :type name: str
101- :param relates_to: Reference to another conversation or activity
119+ :param relates_to: A reference to another conversation or activity.
102120 :type relates_to: ~botframework.connector.models.ConversationReference
103- :param code: Code indicating why the conversation has ended. Possible
104- values include: 'unknown', 'completedSuccessfully', 'userCancelled',
105- 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'
121+ :param code: The a code for endOfConversation activities that indicates
122+ why the conversation ended. Possible values include: 'unknown',
123+ 'completedSuccessfully', 'userCancelled', 'botTimedOut',
124+ 'botIssuedInvalidMessage', 'channelFailed'
106125 :type code: str or ~botframework.connector.models.EndOfConversationCodes
107- :param expiration: DateTime to expire the activity as ISO 8601 encoded
108- datetime
126+ :param expiration: The time at which the activity should be considered to
127+ be "expired" and should not be presented to the recipient.
109128 :type expiration: datetime
110- :param importance: Importance of this activity
111- {Low|Normal|High}, null value indicates Normal importance see
112- ActivityImportance)
113- :type importance: str
114- :param delivery_mode: Hint to describe how this activity should be
115- delivered.
116- Currently: null or "Default" = default delivery
117- "Notification" = notification semantics
118- :type delivery_mode: str
119- :param text_highlights: TextHighlight in the activity represented in the
120- ReplyToId property
129+ :param importance: The importance of the activity. Possible values
130+ include: 'low', 'normal', 'high'
131+ :type importance: str or ~botframework.connector.models.ActivityImportance
132+ :param delivery_mode: A delivery hint to signal to the recipient alternate
133+ delivery paths for the activity.
134+ The default delivery mode is "default". Possible values include: 'normal',
135+ 'notification'
136+ :type delivery_mode: str or ~botframework.connector.models.DeliveryModes
137+ :param listen_for: List of phrases and references that speech and language
138+ priming systems should listen for
139+ :type listen_for: list[str]
140+ :param text_highlights: The collection of text fragments to highlight when
141+ the activity contains a ReplyToId value.
121142 :type text_highlights: list[~botframework.connector.models.TextHighlight]
143+ :param semantic_action: An optional programmatic action accompanying this
144+ request
145+ :type semantic_action: ~botframework.connector.models.SemanticAction
122146 """
123147
124148 _attribute_map = {
125149 'type' : {'key' : 'type' , 'type' : 'str' },
126150 'id' : {'key' : 'id' , 'type' : 'str' },
127151 'timestamp' : {'key' : 'timestamp' , 'type' : 'iso-8601' },
128152 'local_timestamp' : {'key' : 'localTimestamp' , 'type' : 'iso-8601' },
153+ 'local_timezone' : {'key' : 'localTimezone' , 'type' : 'str' },
129154 'service_url' : {'key' : 'serviceUrl' , 'type' : 'str' },
130155 'channel_id' : {'key' : 'channelId' , 'type' : 'str' },
131- 'from_property ' : {'key' : 'from' , 'type' : 'ChannelAccount' },
156+ 'from ' : {'key' : 'from' , 'type' : 'ChannelAccount' },
132157 'conversation' : {'key' : 'conversation' , 'type' : 'ConversationAccount' },
133158 'recipient' : {'key' : 'recipient' , 'type' : 'ChannelAccount' },
134159 'text_format' : {'key' : 'textFormat' , 'type' : 'str' },
@@ -159,7 +184,9 @@ class Activity(Model):
159184 'expiration' : {'key' : 'expiration' , 'type' : 'iso-8601' },
160185 'importance' : {'key' : 'importance' , 'type' : 'str' },
161186 'delivery_mode' : {'key' : 'deliveryMode' , 'type' : 'str' },
187+ 'listen_for' : {'key' : 'listenFor' , 'type' : '[str]' },
162188 'text_highlights' : {'key' : 'textHighlights' , 'type' : '[TextHighlight]' },
189+ 'semantic_action' : {'key' : 'semanticAction' , 'type' : 'SemanticAction' },
163190 }
164191
165192 def __init__ (self , ** kwargs ):
@@ -168,9 +195,10 @@ def __init__(self, **kwargs):
168195 self .id = kwargs .get ('id' , None )
169196 self .timestamp = kwargs .get ('timestamp' , None )
170197 self .local_timestamp = kwargs .get ('local_timestamp' , None )
198+ self .local_timezone = kwargs .get ('local_timezone' , None )
171199 self .service_url = kwargs .get ('service_url' , None )
172200 self .channel_id = kwargs .get ('channel_id' , None )
173- self .from_property = kwargs .get ('from_property ' , None )
201+ self .from = kwargs .get ('from ' , None )
174202 self .conversation = kwargs .get ('conversation' , None )
175203 self .recipient = kwargs .get ('recipient' , None )
176204 self .text_format = kwargs .get ('text_format' , None )
@@ -201,4 +229,6 @@ def __init__(self, **kwargs):
201229 self .expiration = kwargs .get ('expiration' , None )
202230 self .importance = kwargs .get ('importance' , None )
203231 self .delivery_mode = kwargs .get ('delivery_mode' , None )
232+ self .listen_for = kwargs .get ('listen_for' , None )
204233 self .text_highlights = kwargs .get ('text_highlights' , None )
234+ self .semantic_action = kwargs .get ('semantic_action' , None )
0 commit comments