Activity Classe
Une activité est le type de communication de base pour le protocole Bot Framework 3.0.
- Héritage
-
msrest.serialization.ModelActivity
Constructeur
Activity(*, type=None, id: str = None, timestamp=None, local_timestamp=None, local_timezone: str = None, service_url: str = None, channel_id: str = None, from_property=None, conversation=None, recipient=None, text_format=None, attachment_layout=None, members_added=None, members_removed=None, reactions_added=None, reactions_removed=None, topic_name: str = None, history_disclosed: bool = None, locale: str = None, text: str = None, speak: str = None, input_hint=None, summary: str = None, suggested_actions=None, attachments=None, entities=None, channel_data=None, action: str = None, reply_to_id: str = None, label: str = None, value_type: str = None, value=None, name: str = None, relates_to=None, code=None, expiration=None, importance=None, delivery_mode=None, listen_for=None, text_highlights=None, semantic_action=None, caller_id: str = None, **kwargs)Paramètres
| Nom | Description |
|---|---|
|
type
Obligatoire
|
str ou
<xref:botframework.connector.models.ActivityTypes>
Contient le type d’activité. Les valeurs possibles sont les suivantes : 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' |
|
id
Obligatoire
|
Contient un ID qui identifie de manière unique l’activité sur le canal. |
|
timestamp
Obligatoire
|
Contient la date et l’heure d’envoi du message, en UTC, exprimées au format ISO-8601. |
|
local_timestamp
Obligatoire
|
Contient la date et l’heure locales du message exprimé au format ISO-8601. Par exemple, 2016-09-23T13 :07 :49.4714686-07 :00. |
|
local_timezone
Obligatoire
|
Contient le nom du fuseau horaire local du message, exprimé au format de base de données de fuseau horaire IANA. Par exemple, America/Los_Angeles. |
|
service_url
Obligatoire
|
Contient l’URL qui spécifie le point de terminaison de service du canal. Défini par le canal. |
|
channel_id
Obligatoire
|
Contient un ID qui identifie de manière unique le canal. Défini par le canal. |
|
from_property
Obligatoire
|
<xref:botframework.connector.models.ChannelAccount>
Identifie l’expéditeur du message. |
|
conversation
Obligatoire
|
<xref:botframework.connector.models.ConversationAccount>
Identifie la conversation à laquelle l’activité appartient. |
|
recipient
Obligatoire
|
<xref:botframework.connector.models.ChannelAccount>
Identifie le destinataire du message. |
|
text_format
Obligatoire
|
str ou
<xref:botframework.connector.models.TextFormatTypes>
Format des champs de texte Default :markdown. Les valeurs possibles sont les suivantes : 'markdown', 'plain', 'xml' |
|
attachment_layout
Obligatoire
|
str ou
<xref:botframework.connector.models.AttachmentLayoutTypes>
Indicateur de disposition pour plusieurs pièces jointes. Valeur par défaut : liste. Les valeurs possibles sont les suivantes : 'list', 'carrousel' |
|
members_added
Obligatoire
|
list[<xref:botframework.connector.models.ChannelAccount>]
Collection de membres ajoutés à la conversation. |
|
members_removed
Obligatoire
|
list[<xref:botframework.connector.models.ChannelAccount>]
Collection de membres supprimés de la conversation. |
|
reactions_added
Obligatoire
|
list[<xref:botframework.connector.models.MessageReaction>]
Collection de réactions ajoutées à la conversation. |
|
reactions_removed
Obligatoire
|
list[<xref:botframework.connector.models.MessageReaction>]
Collection de réactions supprimées de la conversation. |
|
topic_name
Obligatoire
|
Nom de la rubrique mise à jour de la conversation. |
|
history_disclosed
Obligatoire
|
Indique si l’historique antérieur du canal est divulgué. |
|
locale
Obligatoire
|
Nom des paramètres régionaux pour le contenu du champ de texte. Le nom des paramètres régionaux est une combinaison d’un code de culture ISO 639 à deux ou trois lettres associé à une langue et d’un code de sous-culture à deux lettres ISO 3166 associé à un pays ou à une région. Le nom des paramètres régionaux peut également correspondre à une balise de langue BCP-47 valide. |
|
text
Obligatoire
|
Contenu textuel du message. |
|
speak
Obligatoire
|
Texte à lire. |
|
input_hint
Obligatoire
|
str ou
<xref:botframework.connector.models.InputHints>
Indique si votre bot accepte, attend ou ignore l’entrée utilisateur une fois le message remis au client. Les valeurs possibles sont les suivantes : 'acceptInput', 'ignoringInput', 'expectingInput' |
|
summary
Obligatoire
|
Texte à afficher si le canal ne peut pas afficher les cartes. |
|
suggested_actions
Obligatoire
|
<xref:botframework.connector.models.SuggestedActions>
Actions suggérées pour l’activité. |
|
attachments
Obligatoire
|
list[<xref:botframework.connector.models.Attachment>]
Pièces jointes |
|
entities
Obligatoire
|
list[<xref:botframework.connector.models.Entity>]
Représente les entités qui ont été mentionnées dans le message. |
|
channel_data
Obligatoire
|
Contient du contenu spécifique au canal. |
|
action
Obligatoire
|
Indique si le destinataire d’un contactRelationUpdate a été ajouté ou supprimé de la liste de contacts de l’expéditeur. |
|
reply_to_id
Obligatoire
|
Contient l’ID du message auquel ce message est une réponse. |
|
label
Obligatoire
|
Étiquette descriptive de l’activité. |
|
value_type
Obligatoire
|
Type de l’objet de valeur de l’activité. |
|
value
Obligatoire
|
Valeur associée à l’activité. |
|
name
Obligatoire
|
Nom de l’opération associée à une activité d’appel ou d’événement. |
|
relates_to
Obligatoire
|
<xref:botframework.connector.models.ConversationReference>
Référence à une autre conversation ou activité. |
|
code
Obligatoire
|
str ou
<xref:botframework.connector.models.EndOfConversationCodes>
Code pour les activités endOfConversation qui indique la raison pour laquelle la conversation s’est terminée. Les valeurs possibles sont les suivantes : 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed' |
|
expiration
Obligatoire
|
Heure à laquelle l’activité doit être considérée comme étant « expirée » et ne doit pas être présentée au destinataire. |
|
importance
Obligatoire
|
str ou
<xref:botframework.connector.models.ActivityImportance>
Importance de l’activité. Les valeurs possibles sont les suivantes : 'low', 'normal', 'high' |
|
delivery_mode
Obligatoire
|
str ou
<xref:botframework.connector.models.DeliveryModes>
Indicateur de distribution pour signaler au destinataire d’autres chemins de distribution pour l’activité. Le mode de remise par défaut est « default ». Les valeurs possibles sont les suivantes : 'normal', 'notification', 'expectReplies', 'éphémère' |
|
listen_for
Obligatoire
|
Liste d’expressions et de références que les systèmes d’amorçage vocal et linguistique doivent écouter |
|
text_highlights
Obligatoire
|
list[<xref:botframework.connector.models.TextHighlight>]
Collection de fragments de texte à mettre en surbrillance lorsque l’activité contient une valeur ReplyToId. |
|
semantic_action
Obligatoire
|
<xref:botframework.connector.models.SemanticAction>
Action par programme facultative accompagnant cette demande |
|
caller_id
Obligatoire
|
Chaîne contenant un IRI identifiant l’appelant d’un bot. Ce champ n’est pas destiné à être transmis sur le réseau, mais il est rempli par les bots et les clients basés sur des données vérifiables par chiffrement qui déclarent l’identité des appelants (par exemple des jetons). |
Paramètres de mot clé uniquement
| Nom | Description |
|---|---|
|
type
Obligatoire
|
|
|
id
Obligatoire
|
|
|
timestamp
Obligatoire
|
|
|
local_timestamp
Obligatoire
|
|
|
local_timezone
Obligatoire
|
|
|
service_url
Obligatoire
|
|
|
channel_id
Obligatoire
|
|
|
from_property
Obligatoire
|
|
|
conversation
Obligatoire
|
|
|
recipient
Obligatoire
|
|
|
text_format
Obligatoire
|
|
|
attachment_layout
Obligatoire
|
|
|
members_added
Obligatoire
|
|
|
members_removed
Obligatoire
|
|
|
reactions_added
Obligatoire
|
|
|
reactions_removed
Obligatoire
|
|
|
topic_name
Obligatoire
|
|
|
history_disclosed
Obligatoire
|
|
|
locale
Obligatoire
|
|
|
text
Obligatoire
|
|
|
speak
Obligatoire
|
|
|
input_hint
Obligatoire
|
|
|
summary
Obligatoire
|
|
|
suggested_actions
Obligatoire
|
|
|
attachments
Obligatoire
|
|
|
entities
Obligatoire
|
|
|
channel_data
Obligatoire
|
|
|
action
Obligatoire
|
|
|
reply_to_id
Obligatoire
|
|
|
label
Obligatoire
|
|
|
value_type
Obligatoire
|
|
|
value
Obligatoire
|
|
|
name
Obligatoire
|
|
|
relates_to
Obligatoire
|
|
|
code
Obligatoire
|
|
|
expiration
Obligatoire
|
|
|
importance
Obligatoire
|
|
|
delivery_mode
Obligatoire
|
|
|
listen_for
Obligatoire
|
|
|
text_highlights
Obligatoire
|
|
|
semantic_action
Obligatoire
|
|
|
caller_id
Obligatoire
|
|
Méthodes
| apply_conversation_reference |
Mises à jour cette activité avec les informations de remise d’une ConversationReference existante activité entrante, où le bot est le destinataire ; sinon, False. La valeur par défaut est False et l’activité affiche le bot en tant qu’expéditeur. |
| as_contact_relation_update_activity |
Retourne cette activité sous la forme d’un objet ContactRelationUpdateActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_conversation_update_activity |
Retourne cette activité sous la forme d’un objet ConversationUpdateActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_end_of_conversation_activity |
Retourne cette activité sous la forme d’un objet EndOfConversationActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_event_activity |
Retourne cette activité en tant qu’objet EventActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_handoff_activity |
Retourne cette activité en tant qu’objet HandoffActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_installation_update_activity |
Retourne cette activité sous la forme d’un objet InstallationUpdateActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_invoke_activity |
Retourne cette activité sous la forme d’un objet InvokeActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_message_activity |
Retourne cette activité en tant qu’objet MessageActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_message_delete_activity |
Retourne cette activité sous la forme d’un objet MessageDeleteActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_message_reaction_activity |
Retourne cette activité sous la forme d’un objet MessageReactionActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_message_update_activity |
Retourne cette activité sous la forme d’un objet MessageUpdateActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_suggestion_activity |
Retourne cette activité sous la forme d’un objet SuggestionActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_trace_activity |
Retourne cette activité sous la forme d’un objet TraceActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité. |
| as_typing_activity |
Retourne cette activité en tant qu’objet TypingActivity ; ou null, si ce n’est pas ce type d’activité. |
| create_contact_relation_update_activity |
Crée un instance de la Activity classe en tant qu’objetContactRelationUpdateActivity. |
| create_conversation_update_activity |
Crée un instance de la Activity classe en tant qu’objet ConversationUpdateActivity. |
| create_end_of_conversation_activity |
Crée un instance de la Activity classe en tant qu’objet EndOfConversationActivity. |
| create_event_activity |
Crée un instance de la Activity classe en tant qu’objet EventActivity. |
| create_handoff_activity |
Crée un instance de la Activity classe en tant qu’objet HandoffActivity. |
| create_invoke_activity |
Crée un instance de la Activity classe en tant qu’objet InvokeActivity. |
| create_message_activity |
Crée un instance de la Activity classe en tant qu’objet MessageActivity. |
| create_reply |
Crée une activité de message en réponse à cette activité. |
| create_trace |
Crée une activité de suivi basée sur cette activité. La valeur par défaut est le nom du type de la valeur. :p aram label : facultatif, étiquette descriptive pour cette opération de trace. |
| create_trace_activity |
Crée un instance de la Activity classe en tant qu’objet TraceActivity. La valeur par défaut est le nom du type de la valeur. :p aram label : facultatif, étiquette descriptive pour cette opération de trace. |
| create_typing_activity |
Crée un instance de la Activity classe en tant qu’objet TypingActivity. |
| get_conversation_reference |
Crée une conversationReference basée sur cette activité. |
| get_mentions |
Résout les mentions des entités de cette activité. |
| get_reply_conversation_reference |
Créez une ConversationReference basée sur les informations de conversation de cette activité et la ressourceResponse de l’envoi d’une activité. |
| has_content |
Indique si cette activité a du contenu. |
| is_from_streaming_connection |
Déterminer si l’activité a été envoyée via une connexion Http/Https ou une diffusion en continu Ceci peut être déterminé en examinant la propriété service_url : (1) Tous les canaux qui envoient des messages via http/https ne sont pas en streaming (2) Les canaux qui envoient des messages via la diffusion en continu ont un ServiceUrl qui ne commence pas par http/https. |
apply_conversation_reference
Mises à jour cette activité avec les informations de remise d’une ConversationReference existante
activité entrante, où le bot est le destinataire ; sinon, False. La valeur par défaut est False et l’activité affiche le bot en tant qu’expéditeur.
apply_conversation_reference(reference: ConversationReference, is_incoming: bool = False)Paramètres
| Nom | Description |
|---|---|
|
reference
Obligatoire
|
|
|
is_incoming
|
Valeur par défaut: False
|
Retours
| Type | Description |
|---|---|
|
son activité, mise à jour avec les informations de livraison. |
Remarques
Appelez GetConversationReference sur une activité entrante pour obtenir une référence de conversation que vous pouvez ensuite utiliser pour mettre à jour une activité sortante avec les informations de remise correctes.
as_contact_relation_update_activity
Retourne cette activité sous la forme d’un objet ContactRelationUpdateActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_contact_relation_update_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de message ; ou Aucun. |
as_conversation_update_activity
Retourne cette activité sous la forme d’un objet ConversationUpdateActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_conversation_update_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de mise à jour de conversation ; ou Aucun. |
as_end_of_conversation_activity
Retourne cette activité sous la forme d’un objet EndOfConversationActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_end_of_conversation_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de fin de conversation ; ou Aucun. |
as_event_activity
Retourne cette activité en tant qu’objet EventActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_event_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité événementielle ; ou Aucun. |
as_handoff_activity
Retourne cette activité en tant qu’objet HandoffActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_handoff_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de transfert ; ou Aucun. |
as_installation_update_activity
Retourne cette activité sous la forme d’un objet InstallationUpdateActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_installation_update_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de mise à jour d’installation ; ou Aucun. |
as_invoke_activity
Retourne cette activité sous la forme d’un objet InvokeActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_invoke_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité d’appel ; ou Aucun. |
as_message_activity
Retourne cette activité en tant qu’objet MessageActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_message_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de message ; ou Aucun. |
as_message_delete_activity
Retourne cette activité sous la forme d’un objet MessageDeleteActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_message_delete_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant que demande de suppression de message ; ou Aucun. |
as_message_reaction_activity
Retourne cette activité sous la forme d’un objet MessageReactionActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_message_reaction_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de réaction de message ; ou Aucun. |
as_message_update_activity
Retourne cette activité sous la forme d’un objet MessageUpdateActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_message_update_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant que demande de mise à jour de message ; ou Aucun. |
as_suggestion_activity
Retourne cette activité sous la forme d’un objet SuggestionActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_suggestion_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de suggestion ; ou Aucun. |
as_trace_activity
Retourne cette activité sous la forme d’un objet TraceActivity ; ou Aucun, s’il ne s’agit pas de ce type d’activité.
as_trace_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de suivi ; ou Aucun. |
as_typing_activity
Retourne cette activité en tant qu’objet TypingActivity ; ou null, si ce n’est pas ce type d’activité.
as_typing_activity()Retours
| Type | Description |
|---|---|
|
Cette activité en tant qu’activité de saisie ; ou null. |
create_contact_relation_update_activity
Crée un instance de la Activity classe en tant qu’objetContactRelationUpdateActivity.
static create_contact_relation_update_activity()Retours
| Type | Description |
|---|---|
|
Nouvelle activité de mise à jour de la relation de contact. |
create_conversation_update_activity
Crée un instance de la Activity classe en tant qu’objet ConversationUpdateActivity.
static create_conversation_update_activity()Retours
| Type | Description |
|---|---|
|
Nouvelle activité de mise à jour de conversation. |
create_end_of_conversation_activity
Crée un instance de la Activity classe en tant qu’objet EndOfConversationActivity.
static create_end_of_conversation_activity()Retours
| Type | Description |
|---|---|
|
Nouvelle fin de l’activité de conversation. |
create_event_activity
Crée un instance de la Activity classe en tant qu’objet EventActivity.
static create_event_activity()Retours
| Type | Description |
|---|---|
|
Nouvelle activité d’événement. |
create_handoff_activity
Crée un instance de la Activity classe en tant qu’objet HandoffActivity.
static create_handoff_activity()Retours
| Type | Description |
|---|---|
|
Nouvelle activité de transfert. |
create_invoke_activity
Crée un instance de la Activity classe en tant qu’objet InvokeActivity.
static create_invoke_activity()Retours
| Type | Description |
|---|---|
|
Nouvelle activité d’appel. |
create_message_activity
Crée un instance de la Activity classe en tant qu’objet MessageActivity.
static create_message_activity()Retours
| Type | Description |
|---|---|
|
Nouvelle activité de message. |
create_reply
Crée une activité de message en réponse à cette activité.
create_reply(text: str = None, locale: str = None)Paramètres
| Nom | Description |
|---|---|
|
text
|
Texte de la réponse. Valeur par défaut: None
|
|
locale
|
Code de langue du texte. Valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
|
Nouvelle activité de message. |
Remarques
La nouvelle activité configure les informations de routage en fonction de cette activité.
create_trace
Crée une activité de suivi basée sur cette activité.
La valeur par défaut est le nom du type de la valeur. :p aram label : facultatif, étiquette descriptive pour cette opération de trace.
create_trace(name: str, value: object = None, value_type: str = None, label: str = None)Paramètres
| Nom | Description |
|---|---|
|
name
Obligatoire
|
|
|
value
|
Valeur par défaut: None
|
|
value_type
|
Valeur par défaut: None
|
|
label
|
Valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
|
Nouvelle activité de trace. |
create_trace_activity
Crée un instance de la Activity classe en tant qu’objet TraceActivity.
La valeur par défaut est le nom du type de la valeur. :p aram label : facultatif, étiquette descriptive pour cette opération de trace.
static create_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None)Paramètres
| Nom | Description |
|---|---|
|
name
Obligatoire
|
|
|
value
|
Valeur par défaut: None
|
|
value_type
|
Valeur par défaut: None
|
|
label
|
Valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
|
Nouvelle activité de trace. |
create_typing_activity
Crée un instance de la Activity classe en tant qu’objet TypingActivity.
static create_typing_activity()Retours
| Type | Description |
|---|---|
|
Nouvelle activité de saisie. |
get_conversation_reference
Crée une conversationReference basée sur cette activité.
get_conversation_reference()Retours
| Type | Description |
|---|---|
|
Référence de conversation pour la conversation qui contient cette activité. |
get_mentions
Résout les mentions des entités de cette activité.
get_mentions() -> List[Mention]Retours
| Type | Description |
|---|---|
|
Tableau de mentions ; ou un tableau vide, si aucun n’est trouvé. |
Remarques
Cette méthode est définie sur la Activity classe , mais elle est uniquement destinée à être utilisée avec une activité de message, où l’activité Activity.Type est définie sur ActivityTypes.Message.
get_reply_conversation_reference
Créez une ConversationReference basée sur les informations de conversation de cette activité et la ressourceResponse de l’envoi d’une activité.
get_reply_conversation_reference(reply: ResourceResponse) -> ConversationReferenceParamètres
| Nom | Description |
|---|---|
|
reply
Obligatoire
|
ResourceResponse retourné par send_activity. |
Retours
| Type | Description |
|---|---|
|
ConversationReference qui peut être stockée et utilisée ultérieurement pour supprimer ou mettre à jour l’activité. |
has_content
Indique si cette activité a du contenu.
has_content() -> boolRetours
| Type | Description |
|---|---|
|
True, si cette activité a du contenu à envoyer ; sinon, false. |
Remarques
Cette méthode est définie sur la Activity classe , mais elle est uniquement destinée à être utilisée avec une activité de message, où l’activité Activity.Type est définie sur ActivityTypes.Message.
is_from_streaming_connection
Déterminer si l’activité a été envoyée via une connexion Http/Https ou une diffusion en continu Ceci peut être déterminé en examinant la propriété service_url : (1) Tous les canaux qui envoient des messages via http/https ne sont pas en streaming (2) Les canaux qui envoient des messages via la diffusion en continu ont un ServiceUrl qui ne commence pas par http/https.
is_from_streaming_connection() -> boolRetours
| Type | Description |
|---|---|
|
True si l’activité provient d’une connexion de streaming. |