Activity Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Une activité est le type de communication de base pour le protocole Bot Framework 3.0.
public class Activity : Microsoft.Bot.Schema.ICommandActivity, Microsoft.Bot.Schema.ICommandResultActivity, Microsoft.Bot.Schema.IContactRelationUpdateActivity, Microsoft.Bot.Schema.IConversationUpdateActivity, Microsoft.Bot.Schema.IEndOfConversationActivity, Microsoft.Bot.Schema.IEventActivity, Microsoft.Bot.Schema.IHandoffActivity, Microsoft.Bot.Schema.IInstallationUpdateActivity, Microsoft.Bot.Schema.IInvokeActivity, Microsoft.Bot.Schema.IMessageDeleteActivity, Microsoft.Bot.Schema.IMessageReactionActivity, Microsoft.Bot.Schema.IMessageUpdateActivity, Microsoft.Bot.Schema.ISuggestionActivity, Microsoft.Bot.Schema.ITraceActivity, Microsoft.Bot.Schema.ITypingActivity
type Activity = class
interface IActivity
interface IConversationUpdateActivity
interface IContactRelationUpdateActivity
interface IInstallationUpdateActivity
interface IMessageActivity
interface IMessageUpdateActivity
interface IMessageDeleteActivity
interface IMessageReactionActivity
interface ISuggestionActivity
interface ITypingActivity
interface IEndOfConversationActivity
interface IEventActivity
interface IInvokeActivity
interface ITraceActivity
interface IHandoffActivity
interface ICommandActivity
interface ICommandResultActivity
Public Class Activity
Implements ICommandActivity, ICommandResultActivity, IContactRelationUpdateActivity, IConversationUpdateActivity, IEndOfConversationActivity, IEventActivity, IHandoffActivity, IInstallationUpdateActivity, IInvokeActivity, IMessageDeleteActivity, IMessageReactionActivity, IMessageUpdateActivity, ISuggestionActivity, ITraceActivity, ITypingActivity
- Héritage
-
Activity
- Implémente
-
IActivity ICommandActivity ICommandResultActivity IContactRelationUpdateActivity IConversationUpdateActivity IEndOfConversationActivity IEventActivity IHandoffActivity IInstallationUpdateActivity IInvokeActivity IMessageActivity IMessageDeleteActivity IMessageReactionActivity IMessageUpdateActivity ISuggestionActivity ITraceActivity ITypingActivity
Remarques
La classe Activity contient toutes les propriétés que des activités individuelles et plus spécifiques peuvent contenir. Il s’agit d’un type de sur-ensemble.
Constructeurs
Champs
ContentType |
En-tête d’entité HTTP |
Propriétés
Action |
Obtient ou définit une chaîne indiquant si le destinataire d’un contactRelationUpdate a été ajouté ou supprimé de la liste de contacts de l’expéditeur. |
AttachmentLayout |
Obtient ou définit l’indicateur de disposition pour plusieurs pièces jointes. Valeur par défaut : list. Les valeurs possibles sont définies par AttachmentLayoutTypes. |
Attachments |
Obtient ou définit les pièces jointes pour l’activité. |
CallerId |
Obtient ou définit une chaîne contenant une 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). |
ChannelData |
Obtient ou définit le contenu spécifique au canal. |
ChannelId |
Obtient ou définit un ID qui identifie de manière unique le canal. Défini par le canal. |
Code |
Obtient ou définit un code pour les activités endOfConversation qui indique la raison pour laquelle la conversation s’est terminée. Les valeurs possibles sont définies dans EndOfConversationCodes. |
Conversation |
Obtient ou définit la conversation à laquelle appartient l’activité. |
DeliveryMode |
Obtient ou définit un indicateur de remise pour signaler au destinataire d’autres chemins de remise pour l’activité. Le mode de remise par défaut est « default ». Les valeurs possibles sont définies dans DeliveryModes. |
Entities |
Obtient ou définit les entités mentionnées dans le message. |
Expiration |
Obtient ou définit l’heure à laquelle l’activité doit être considérée comme « expirée » et ne doit pas être présentée au destinataire. |
From |
Obtient ou définit l’expéditeur du message. |
HistoryDisclosed |
Obtient ou définit une valeur indiquant si l’historique antérieur du canal est divulgué. |
Id |
Obtient ou définit un ID qui identifie de manière unique l’activité sur le canal. |
Importance |
Obtient ou définit l’importance de l’activité. Les valeurs possibles sont définies dans ActivityImportance. |
InputHint |
Obtient ou définit une chaîne indiquant si votre bot accepte, attend ou ignore l’entrée utilisateur une fois le message remis au client (voir InputHints. |
Label |
Obtient ou définit une étiquette descriptive pour l’activité. |
ListenFor |
Obtient ou définit la liste des expressions et références que les systèmes de préparation vocale et linguistique doivent écouter. |
Locale |
Obtient ou définit un nom de paramètres régionaux BCP-47 pour le contenu du champ de texte. |
LocalTimestamp |
Obtient ou définit la date et l’heure d’envoi du message, en heure locale, exprimées au format ISO-8601. Par exemple, 2016-09-23T13:07:49.4714686-07:00. |
LocalTimezone |
Obtient ou définit le nom du fuseau horaire utilisé pour définir l’heure locale du message, exprimé au format de base de données de fuseau horaire IANA. Par exemple, America/Los_Angeles. |
MembersAdded |
Obtient ou définit la collection de membres ajoutés à la conversation. |
MembersRemoved |
Obtient ou définit la collection de membres supprimés de la conversation. |
Name |
Obtient ou définit le nom de l’opération associée à une activité d’appel ou d’événement. |
Properties |
Obtient ou définit des propriétés qui ne sont pas définies par le Activity type, mais qui peuvent apparaître dans l’objet JSON REST sérialisé. |
ReactionsAdded |
Obtient ou définit la collection de réactions ajoutées à la conversation. |
ReactionsRemoved |
Obtient ou définit la collection de réactions supprimées de la conversation. |
Recipient |
Obtient ou définit le destinataire du message. |
RelatesTo |
Obtient ou définit un ConversationReference sur une autre conversation ou activité. |
ReplyToId |
Obtient ou définit l’ID du message auquel ce message est une réponse. |
SemanticAction |
Obtient ou définit une action programmatique facultative qui accompagne cette demande. |
ServiceUrl |
Obtient ou définit l’URL qui spécifie le point de terminaison de service du canal. Défini par le canal. |
Speak |
Obtient ou définit le texte à parler. |
SuggestedActions |
Obtient ou définit les actions suggérées pour l’activité. |
Summary |
Obtient ou définit le texte à afficher si le canal ne peut pas afficher les cartes. |
Text |
Obtient ou définit le contenu texte du message. |
TextFormat |
Obtient ou définit le format des champs de texte. Valeur par défaut : markdown. Les valeurs possibles sont définies par TextFormatTypes. |
TextHighlights |
Obtient ou définit la collection de fragments de texte à mettre en surbrillance lorsque l’activité contient une valeur ReplyToId. |
Timestamp |
Obtient ou définit la date et l’heure d’envoi du message, en UTC, exprimées au format ISO-8601. |
TopicName |
Obtient ou définit le nom de la rubrique mise à jour de la conversation. |
Type |
Obtient ou définit le type d’activité. Les valeurs possibles sont « message », « contactRelationUpdate », « conversationUpdate », « typing », « endOfConversation », « event », « invoke », « deleteUserData », « messageUpdate », « messageDelete », « installationUpdate », « messageReaction », « suggestion », « trace », « handoff ». |
Value |
Obtient ou définit une valeur associée à l’activité. |
ValueType |
Obtient ou définit le type de l’objet valeur de l’activité. |
Méthodes
ApplyConversationReference(ConversationReference, Boolean) |
Mises à jour cette activité avec les informations de remise d’un existantConversationReference. |
AsCommandActivity() |
Retourne cette activité en tant qu’objet ICommandActivity ; ou null, si ce n’est pas ce type d’activité. |
AsCommandResultActivity() |
Retourne cette activité en tant qu’objet ICommandResultActivity ; ou null, si ce n’est pas ce type d’activité. |
AsContactRelationUpdateActivity() |
Retourne cette activité en tant qu’objet IContactRelationUpdateActivity ; ou null, si ce n’est pas ce type d’activité. |
AsConversationUpdateActivity() |
Retourne cette activité en tant qu’objet IConversationUpdateActivity ; ou null, si ce n’est pas ce type d’activité. |
AsEndOfConversationActivity() |
Retourne cette activité en tant qu’objet IEndOfConversationActivity ; ou null, si ce n’est pas ce type d’activité. |
AsEventActivity() |
Retourne cette activité en tant qu’objet IEventActivity ; ou null, si ce n’est pas ce type d’activité. |
AsHandoffActivity() |
Retourne cette activité en tant qu’objet IHandoffActivity ; ou null, si ce n’est pas ce type d’activité. |
AsInstallationUpdateActivity() |
Retourne cette activité en tant qu’objet IInstallationUpdateActivity ; ou null, si ce n’est pas ce type d’activité. |
AsInvokeActivity() |
Retourne cette activité en tant qu’objet IInvokeActivity ; ou null, si ce n’est pas ce type d’activité. |
AsMessageActivity() |
Retourne cette activité en tant qu’objet IMessageActivity ; ou null, si ce n’est pas ce type d’activité. |
AsMessageDeleteActivity() |
Retourne cette activité en tant qu’objet IMessageDeleteActivity ; ou null, si ce n’est pas ce type d’activité. |
AsMessageReactionActivity() |
Retourne cette activité en tant qu’objet IMessageReactionActivity ; ou null, si ce n’est pas ce type d’activité. |
AsMessageUpdateActivity() |
Retourne cette activité en tant qu’objet IMessageUpdateActivity ; ou null, si ce n’est pas ce type d’activité. |
AsSuggestionActivity() |
Retourne cette activité en tant qu’objet ISuggestionActivity ; ou null, si ce n’est pas ce type d’activité. |
AsTraceActivity() |
Retourne cette activité en tant qu’objet ITraceActivity ; ou null, si ce n’est pas ce type d’activité. |
AsTypingActivity() |
Retourne cette activité en tant qu’objet ITypingActivity ; ou null, si ce n’est pas ce type d’activité. |
CreateContactRelationUpdateActivity() |
Crée une instance de la Activity classe en tant qu’objet IContactRelationUpdateActivity . |
CreateConversationUpdateActivity() |
Crée une instance de la Activity classe en tant qu’objet IConversationUpdateActivity . |
CreateEndOfConversationActivity() |
Crée une instance de la Activity classe en tant qu’objet IEndOfConversationActivity . |
CreateEventActivity() |
Crée une instance de la Activity classe en tant qu’objet IEventActivity . |
CreateHandoffActivity() |
Crée une instance de la Activity classe en tant qu’objet IHandoffActivity . |
CreateInvokeActivity() |
Crée une instance de la Activity classe en tant qu’objet IInvokeActivity . |
CreateMessageActivity() |
Crée une instance de la Activity classe en tant qu’objet IMessageActivity . |
CreateReply(String, String) |
Crée une activité de message en réponse à cette activité. |
CreateTrace(String, Object, String, String) |
Crée une activité de suivi basée sur cette activité. |
CreateTraceActivity(String, String, Object, String) |
Crée une instance de la Activity classe en tant qu’objet ITraceActivity . |
CreateTypingActivity() |
Crée une instance de la Activity classe en tant qu’objet ITypingActivity . |
GetChannelData<TypeT>() |
Obtient les données de canal pour cette activité en tant qu’objet fortement typé. |
GetConversationReference() |
Crée un ConversationReference basé sur cette activité. |
GetMentions() |
Résout les mentions des entités de cette activité. |
GetReplyConversationReference(ResourceResponse) |
Créez une ConversationReference basée sur les informations de conversation de cette activité et la ressourceResponse de l’envoi d’une activité. |
HasContent() |
Indique si cette activité a du contenu. |
IsActivity(String) |
Indique si cette activité est d’un type d’activité spécifié. |
IsFromStreamingConnection() |
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é ServiceUrl : (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. |
TryGetChannelData<TypeT>(TypeT) |
Obtient les données de canal pour cette activité en tant qu’objet fortement typé. Une valeur de retour indique si l’opération a réussi. |
Méthodes d’extension
TeamsGetChannelId(IActivity) |
Obtient l’ID de canal de l’équipe à partir de l’activité actuelle. |
TeamsGetMeetingInfo(IActivity) |
Obtient l’objet TeamsMeetingInfo de l’activité actuelle. |
TeamsGetSelectedChannelId(IActivity) |
Obtient l’ID de canal sélectionné de l’équipe à partir de l’activité actuelle. |
TeamsGetTeamInfo(IActivity) |
Obtient l’objet TeamsInfo de l’activité actuelle. |
TeamsNotifyUser(IActivity) |
Configure l’activité actuelle pour générer une notification dans Teams. |
TeamsNotifyUser(IActivity, Boolean, String) |
Configure l’activité actuelle pour générer une notification dans Teams. |
MentionsId(IMessageActivity, String) |
Existe-t-il une mention d’ID dans la propriété Text. |
MentionsRecipient(IMessageActivity) |
Y a-t-il une mention de Recipient.Id dans la propriété Text. |
RemoveMentionText(IMessageActivity, String) |
Supprimez tout texte de mention pour un ID donné de la propriété Activity.Text. Par exemple, étant donné le message @echoBot Hi Bot, cela supprime « @echoBot », en laissant « Hi Bot ». |
RemoveRecipientMention(IMessageActivity) |
Supprimez le texte de la mention du destinataire de la propriété Text. Utilisez avec précaution, car cette fonction modifie le texte de l’activité. |
GetLocale(IActivity) |
Obtient les paramètres régionaux de l’activité. |
SetLocale(IActivity, String) |
Définit les paramètres régionaux de l’activité. |