Activity Classe

  • java.lang.Object
    • com.microsoft.bot.schema.Activity

public class Activity

La classe Activity contient toutes les propriétés que des activités individuelles, plus spécifiques peuvent contenir. Il s’agit d’un type superset.

Récapitulatif du constructeur

Modificateur Constructeur Description
protected Activity()

Constructeur par défaut.

Activity(String withType)

Construisez une activité du type spécifié.

Résumé de la méthode

Modificateur et type Méthode et description
TypeT <TypeT>getChannelData(Class<TypeT> classType)

Obtenir le canalDonnées en tant que structure typée.

ResultPair<TypeT> <TypeT>tryGetChannelData(Class<TypeT> clsType)

Obtenir le canalDonnées en tant que structure typée.

final Activity applyConversationReference(ConversationReference reference)

Met à jour cette activité avec les informations de remise sortantes d’un ConversationReferenceexistant.

final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)

Met à jour cette activité avec les informations de remise d’un ConversationReferenceexistant.

static Activity clone(Activity activity)

Clonez une activité.

static Activity createContactRelationUpdateActivity()

Créez une activité de type CONTACT_RELATION_UPDATE.

static Activity createConversationUpdateActivity()

Créez une activité de type CONVERSATION_UPDATE.

static Activity createEndOfConversationActivity()

Crée un type d’activité END_OF_CONVERSATION.

static Activity createEventActivity()

Crée un type EVENT d’activité.

static Activity createHandoffActivity()

Crée une activité de type HANDOFF.

static Activity createInvokeActivity()

Crée un type INVOKE d’activité.

static Activity createMessageActivity()

Créez une activité de type MESSAGE.

Activity createReply()

Crée une activité de message en tant que réponse à cette activité.

Activity createReply(String withText)

Crée une activité de message en tant que réponse à cette activité.

Activity createReply(String withText, String withLocale)

Crée une activité de message en tant que réponse à cette activité.

Activity createTrace(String withName)

Crée une instance de la classe Activity en tant que type TRACE.

Activity createTrace(String withName, Object withValue, String withValueType, String withLabel)

Crée une instance de la classe Activity en tant que type TRACE.

static Activity createTraceActivity(String withName)

Créez une activité de type TRACE.

static Activity createTraceActivity(String withName, String withValueType, Object withValue, String withLabel)

Créez une activité de type TRACE.

static Activity createTypingActivity()

Crée une activité de type TYPING.

java.lang.String getAction()

Indique si le destinataire d’un contactRelationUpdate a été ajouté ou supprimé de la liste de contacts de l’expéditeur.

AttachmentLayoutTypes getAttachmentLayout()

Indicateur de disposition pour plusieurs pièces jointes.

java.util.List<Attachment> getAttachments()

Obtient les pièces jointes à l’activité.

java.lang.String getCallerId()

Obtient une chaîne contenant une IRI identifiant l’appelant d’un bot.

java.lang.Object getChannelData()

Obtient le contenu spécifique au canal.

java.lang.String getChannelId()

Obtient l’ID qui identifie de façon unique le canal.

EndOfConversationCodes getCode()

Obtient le code de finactivités OfConversation qui indique pourquoi la conversation s’est terminée.

ConversationAccount getConversation()

Identifie la conversation à laquelle appartient l’activité.

ConversationReference getConversationReference()

Crée une ConversationReference basée sur cette activité.

java.lang.String getDeliveryMode()

Indicateur de remise pour signaler au destinataire d’autres chemins de remise de l’activité.

java.util.List<Entity> getEntities()

Retourne la version de charge utile des entités dans une activité.

java.time.LocalDateTime getExpiration()

Obtient l’heure à laquelle l’activité doit être considérée comme expirée et ne doit pas être présentée au destinataire.

ChannelAccount getFrom()

Identifie l’expéditeur du message.

boolean getHistoryDisclosed()

Obtient si l’historique précédent du canal est divulgué.

java.lang.String getId()

Retourne l’ID qui identifie de manière unique l’activité sur le canal.

java.lang.String getImportance()

Obtient l’importance de l’activité.

InputHints getInputHint()

Indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client.

java.lang.String getLabel()

Obtient l’étiquette descriptive de l’activité.

java.util.List<java.lang.String> getListenFor()

Obtient la liste des expressions et références que les systèmes d’amorçage de parole et de langue doivent écouter.

java.time.OffsetDateTime getLocalTimestamp()

Obtient la date et l’heure locales du message, exprimées au format ISO-8601.

java.lang.String getLocalTimezone()

Obtient le nom du fuseau horaire local du message, exprimé au format de base de données de fuseau horaire IANA.

java.lang.String getLocale()

Nom des paramètres régionaux pour le contenu du champ de texte.

java.util.List<ChannelAccount> getMembersAdded()

Obtient la collection de membres ajoutés à la conversation.

java.util.List<ChannelAccount> getMembersRemoved()

Obtient la collection de membres supprimés de la conversation.

java.util.List<Mention> getMentions()

Résout les mentions des entités de cette activité.

java.lang.String getName()

Obtient le nom de l’opération associée à une activité d’appel ou d’événement.

java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> getProperties()

Contient les propriétés de dépassement de capacité qui ne sont pas des propriétés de première classe dans l’objet.

java.util.List<MessageReaction> getReactionsAdded()

Obtient la collection de réactions ajoutées à la conversation.

java.util.List<MessageReaction> getReactionsRemoved()

Obtient la collection de réactions supprimées de la conversation.

ChannelAccount getRecipient()

Identifie le destinataire du message.

ConversationReference getRelatesTo()

Référence à une autre conversation ou activité.

ConversationReference getReplyConversationReference(ResourceResponse reply)

Créez une référenceconversation en fonction des informations de conversation de cette activité et de la réponseressource à partir de l’envoi d’une activité.

java.lang.String getReplyToId()

Obtient l’ID du message auquel ce message est une réponse.

java.lang.String getServiceUrl()

Définit l’URL qui spécifie le point de terminaison de service du canal.

java.lang.String getSpeak()

Texte à parler.

SuggestedActions getSuggestedActions()

Obtient les actions suggérées pour l’activité.

java.lang.String getSummary()

Obtient le texte à afficher si le canal ne peut pas afficher les cartes.

java.lang.String getText()

Obtient le contenu texte du message.

TextFormatTypes getTextFormat()

Format des champs de texte Par défaut :markdown.

java.util.List<TextHighlight> getTextHighlights()

Obtient la collection de fragments de texte à mettre en surbrillance lorsque l’activité contient une valeur De réponseToId.

java.time.OffsetDateTime getTimestamp()

Obtient la date et l’heure à laquelle le message a été envoyé, au format UTC, exprimé au format ISO-8601.

java.lang.String getTopicName()

Obtient le nom de la rubrique mise à jour de la conversation.

java.lang.String getType()

Obtient la ActivityTypes de l’activité.

java.lang.Object getValue()

Obtient la valeur associée à l’activité.

java.lang.String getValueType()

Obtient le type de l’objet valeur de l’activité.

boolean hasContent()

Vérifie si cette activité (message) a du contenu.

protected boolean isActivity(String activityType)

True si l’activité est du type d’activité spécifié.

java.lang.Boolean isFromStreamingConnection()

Détermine si l’activité a été envoyée par le biais d’une connexion Http/Https ou de streaming : (1) Tous les canaux qui envoient des messages via http/https ne sont pas diffusés en continu (2) les canaux qui envoient des messages via la diffusion en continu ont un serviceURL qui ne commence pas par http/https.

boolean isTeamsActivity()

Vérifiez si cette action provient de microsoft teams.

boolean isType(String compareTo)

Méthode pratique à retourner si l’activité est du type spécifié.

java.lang.String removeMentionText(String withId)

Supprimez tout texte de mention pour l’ID donné de l’activité.propriété Text.

static java.lang.String removeMentionTextImmutable(Activity activity, String id)

Supprime la mention de l’activité.texte sans modifier l’activité.

java.lang.String removeRecipientMention()

Supprimez le texte de mention du destinataire de la propriété Text.

static java.lang.String removeRecipientMentionImmutable(Activity activity)

Supprime la mention du destinataire sans modifier l’activité.

void setAction(String withAction)

Indique si le destinataire d’un contactRelationUpdate a été ajouté ou supprimé de la liste de contacts de l’expéditeur.

void setAttachment(Attachment withAttachment)

Définit une pièce jointe unique sur l’activité.

void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)

Définit l’indicateur de disposition pour plusieurs pièces jointes.

void setAttachments(List<Attachment> withAttachments)

Définit les pièces jointes à l’activité.

void setCallerId(String withCallerId)

Définit l’IRI identifiant l’appelant d’un bot.

void setChannelData(Object withChannelData)

Définit le contenu spécifique au canal.

void setChannelId(String withChannelId)

Définit l’ID qui identifie de manière unique le canal.

void setCode(EndOfConversationCodes withCode)

Définit le code de finactivités OfConversation qui indique pourquoi la conversation s’est terminée.

void setConversation(ConversationAccount withConversation)

Identifie la conversation à laquelle appartient l’activité.

void setDeliveryMode(String withDeliveryMode)

Indicateur de remise pour signaler au destinataire d’autres chemins de remise de l’activité.

void setEntities(List<Entity> withEntities)

Définit la version de charge utile des entités dans une activité.

void setExpiration(LocalDateTime withExpiration)

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.

void setFrom(ChannelAccount withFrom)

Identifie l’expéditeur du message.

void setHistoryDisclosed(boolean withHistoryDisclosed)

Définit si l’historique précédent du canal est divulgué.

void setId(String withId)

Définit l’ID qui identifie de manière unique l’activité sur le canal.

void setImportance(String withImportance)

Définit l’importance de l’activité.

void setInputHint(InputHints withInputHint)

Indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client.

void setLabel(String withLabel)

Définit l’étiquette descriptive de l’activité.

void setListenFor(List<String> withListenFor)

Définit la liste des expressions et références que les systèmes d’amorçage de parole et de langue doivent écouter.

void setLocalTimeZone(String withLocalTimezone)

Définit le nom du fuseau horaire local du message, exprimé au format de base de données de fuseau horaire IANA.

void setLocalTimestamp(OffsetDateTime withLocalTimestamp)

Contient la date et l’heure locales du message, exprimées au format ISO-8601.

void setLocale(String withLocale)

Nom des paramètres régionaux pour le contenu du champ de texte.

void setMembersAdded(List<ChannelAccount> withMembersAdded)

Définit la collection de membres ajoutés à la conversation.

void setMembersRemoved(List<ChannelAccount> withMembersRemoved)

Définit la collection de membres supprimés de la conversation.

void setMentions(List<Mention> withMentions)

Définit la version de charge utile des mentions dans une activité.

void setName(String withName)

Définit le nom de l’opération associée à une activité d’appel ou d’événement.

void setProperties(String key, JsonNode withValue)

Contient les propriétés de dépassement de capacité qui ne sont pas des propriétés de première classe dans l’objet.

void setReactionsAdded(List<MessageReaction> withReactionsAdded)

Définit la collection de réactions ajoutées à la conversation.

void setReactionsRemoved(List<MessageReaction> withReactionsRemoved)

Définit la collection de réactions supprimées de la conversation.

void setRecipient(ChannelAccount withRecipient)

Identifie le destinataire du message.

void setRelatesTo(ConversationReference withRelatesTo)

Référence à une autre conversation ou activité.

void setReplyToId(String withReplyToId)

Définit l’ID du message auquel ce message est une réponse.

void setServiceUrl(String withServiceUrl)

Définit l’URL qui spécifie le point de terminaison de service du canal.

void setSpeak(String withSpeak)

Définit le texte à parler.

void setSuggestedActions(SuggestedActions withSuggestedActions)

Actions suggérées pour l’activité.

void setSummary(String withSummary)

Définit le texte à afficher si le canal ne peut pas afficher les cartes.

void setText(String withText)

Définit le contenu texte du message.

void setTextFormat(TextFormatTypes withTextFormat)

Format des champs de texte.

void setTextHighlights(List<TextHighlight> withTextHighlights)

Définit la collection de fragments de texte à mettre en surbrillance lorsque l’activité contient une valeur De réponseToId.

void setTimestamp(OffsetDateTime withTimestamp)

Définit la date et l’heure à laquelle le message a été envoyé, au format UTC, exprimé au format ISO-8601.

void setTopicName(String withTopicName)

Définit le nom de la rubrique mise à jour de la conversation.

void setType(String withType)

Définit la ActivityTypes de l’activité.

void setValue(Object withValue)

Définit la valeur associée à l’activité.

void setValueType(String withValueType)

Définit le type de l’objet valeur de l’activité.

TeamsChannelData teamsGetChannelData()

Obtient les données du canalTeams.

java.lang.String teamsGetChannelId()

Obtenir un identificateur unique représentant un canal.

TeamsMeetingInfo teamsGetMeetingInfo()

Obtient l’objet TeamsMeetingInfo de l’activité actuelle.

java.lang.String teamsGetTeamId()

Obtenir un identificateur unique représentant une équipe.

TeamInfo teamsGetTeamInfo()

Obtenir les données d’informations de l’équipe Teams.

void teamsNotifyUser()

Définit la valeur de notification dans teamsChannelData sur true.

void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)

Définit la notification d’une réunion dans teamsChannelData.

Méthodes héritées de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Détails du constructeur

Activity

protected Activity()

Constructeur par défaut. Normalement, cela ne serait pas utilisé comme ActivityType est normalement requis.

Activity

public Activity(String withType)

Construisez une activité du type spécifié.

Paramètres:

withType - Type d’activité.

Détails de la méthode

<TypeT>getChannelData

public TypeT getChannelData(Class classType)

Obtenir channelData en tant que structure typée.

Paramètres:

classType - Classe de TypeT à utiliser

Retours:

Typed Object ou default(TypeT)

Exception:

com.fasterxml.jackson.core.JsonProcessingException - Si les données du canal ne peuvent pas être converties en TypeT.

<TypeT>tryGetChannelData

public ResultPair tryGetChannelData(Class clsType)

Obtenir channelData en tant que structure typée.

Paramètres:

clsType - Classe de TypeT à utiliser

Retours:

ChannelData en tant que TypeT

applyConversationReference

public final Activity applyConversationReference(ConversationReference reference)

Met à jour cette activité avec les informations de remise sortantes d’un ConversationReferenceexistant.

Paramètres:

reference - Référence de conversation existante.

Retours:

Cette activité, mise à jour avec les informations de remise.

applyConversationReference

public final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)

Met à jour cette activité avec les informations de remise d’un ConversationReferenceexistant. 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.

Paramètres:

reference - Référence de conversation existante.
isIncoming - true pour traiter l’activité comme une activité entrante, où le bot est le destinataire ; sinon, false.

Retours:

Cette activité, mise à jour avec les informations de remise.

clone

public static Activity clone(Activity activity)

Clonez une activité.

Paramètres:

activity - Activité à cloner.

Retours:

nouvelle activité cloné

createContactRelationUpdateActivity

public static Activity createContactRelationUpdateActivity()

Créez une activité de type CONTACT_RELATION_UPDATE.

Retours:

Activité de type de mise à jour de relation de contact.

createConversationUpdateActivity

public static Activity createConversationUpdateActivity()

Créez une activité de type CONVERSATION_UPDATE.

Retours:

Activité de type de mise à jour de conversation.

createEndOfConversationActivity

public static Activity createEndOfConversationActivity()

Crée un type d’activité END_OF_CONVERSATION.

Retours:

Nouvelle fin d’activité de conversation.

createEventActivity

public static Activity createEventActivity()

Crée un type EVENT d’activité.

Retours:

Nouvelle activité d’événement.

createHandoffActivity

public static Activity createHandoffActivity()

Crée une activité de type HANDOFF.

Retours:

Nouvelle activité de transfert.

createInvokeActivity

public static Activity createInvokeActivity()

Crée un type INVOKE d’activité.

Retours:

Nouvelle activité d’appel.

createMessageActivity

public static Activity createMessageActivity()

Créez une activité de type MESSAGE.

Retours:

Type d’activité de message.

createReply

public Activity createReply()

Crée une activité de message en tant que réponse à cette activité.

Retours:

Nouvelle activité de message.

createReply

public Activity createReply(String withText)

Crée une activité de message en tant que réponse à cette activité. Cette surcharge utilise les paramètres régionaux de cette activité.

Paramètres:

withText - Texte de la réponse.

Retours:

Nouvelle activité de message.

createReply

public Activity createReply(String withText, String withLocale)

Crée une activité de message en tant que réponse à cette activité.

Paramètres:

withText - Texte de la réponse.
withLocale - Code de langue du texte.

Retours:

Nouvelle activité de message.

createTrace

public Activity createTrace(String withName)

Crée une instance de la classe Activity en tant que type TRACE.

Paramètres:

withName - Nom de l’opération de trace à créer.

Retours:

Nouvelle activité de trace.

createTrace

public Activity createTrace(String withName, Object withValue, String withValueType, String withLabel)

Crée une instance de la classe Activity en tant que type TRACE.

Paramètres:

withName - Nom de l’opération de trace à créer.
withValue - Facultatif, le contenu de cette opération de trace.
withValueType - Facultatif, identificateur pour le format de withValue. La valeur par défaut est le nom du type withValue.
withLabel - Facultatif, étiquette descriptive pour cette opération de trace.

Retours:

Nouvelle activité de trace.

createTraceActivity

public static Activity createTraceActivity(String withName)

Créez une activité de type TRACE.

Paramètres:

withName - Nom de l’opération

Retours:

Activité de type trace.

createTraceActivity

public static Activity createTraceActivity(String withName, String withValueType, Object withValue, String withLabel)

Créez une activité de type TRACE.

Paramètres:

withName - Nom de l’opération
withValueType - valueType si utile pour identifier le schéma de valeur (la valeur par défaut est la valeur. GetType(). Nom)
withValue - Contenu de cette opération de trace.
withLabel - Étiquette descriptive pour cette opération de trace.

Retours:

Activité de type trace.

createTypingActivity

public static Activity createTypingActivity()

Crée une activité de type TYPING.

Retours:

Nouvelle activité de saisie.

getAction

public String getAction()

Indique si le destinataire d’un contactRelationUpdate a été ajouté ou supprimé de la liste de contacts de l’expéditeur.

Retours:

Action du destinataire.

getAttachmentLayout

public AttachmentLayoutTypes getAttachmentLayout()

Indicateur de disposition pour plusieurs pièces jointes.

Retours:

Type de pièce jointe.

getAttachments

public List getAttachments()

Obtient les pièces jointes à l’activité.

Retours:

Liste des Attachment.

getCallerId

public String getCallerId()

Obtient une chaîne contenant une IRI identifiant l’appelant d’un bot. Ce champ n’est pas destiné à être transmis via le réseau, mais il est plutôt rempli par des bots et des clients basés sur des données vérifiables par chiffrement qui affirment l’identité des appelants (par exemple, des jetons).

Retours:

L’appelant IRI.

getChannelData

public Object getChannelData()

Obtient le contenu spécifique au canal.

Retours:

Données spécifiques au canal.

getChannelId

public String getChannelId()

Obtient l’ID qui identifie de façon unique le canal. Défini par le canal.

Retours:

ID de canal.

getCode

public EndOfConversationCodes getCode()

Obtient le code des activités endOfConversation qui indique pourquoi la conversation s’est terminée.

Retours:

Code endOfConversation.

getConversation

public ConversationAccount getConversation()

Identifie la conversation à laquelle appartient l’activité.

Retours:

getConversationReference

public ConversationReference getConversationReference()

Crée une ConversationReference basée sur cette activité.

Retours:

Référence de conversation pour la conversation qui contient cette activité.

getDeliveryMode

public String getDeliveryMode()

Indicateur de remise pour signaler au destinataire d’autres chemins de remise de l’activité.

Le mode de remise par défaut est \"default\ ». Voir DeliveryModes.

Retours:

Indicateur du mode de remise.

getEntities

public List getEntities()

Retourne la version de charge utile des entités dans une activité. Les entités peuvent varier dans le nombre de champs. La classe Entity contient les champs supplémentaires dans getProperties(). Pour convertir en d’autres types d’entités, utilisez <T>getAs(Class<T> classType).

Retours:

Liste des Entity.

getExpiration

public LocalDateTime getExpiration()

Obtient l’heure à laquelle l’activité doit être considérée comme expirée et ne doit pas être présentée au destinataire.

Retours:

expiration de l’activité.

getFrom

public ChannelAccount getFrom()

Identifie l’expéditeur du message.

Retours:

ChannelAccount de l’expéditeur.

getHistoryDisclosed

public boolean getHistoryDisclosed()

Obtient si l’historique précédent du canal est divulgué.

Retours:

True si l’historique est divulgué.

getId

public String getId()

Retourne l’ID qui identifie de manière unique l’activité sur le canal.

Retours:

ID d’activité.

getImportance

public String getImportance()

Obtient l’importance de l’activité.

Retours:

Importance de l’activité.

getInputHint

public InputHints getInputHint()

Indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client.

Retours:

Indicateur d’entrée pour l’activité.

getLabel

public String getLabel()

Obtient l’étiquette descriptive de l’activité.

Retours:

Étiquette d’activité.

getListenFor

public List getListenFor()

Obtient la liste des expressions et références que les systèmes d’amorçage de parole et de langue doivent écouter.

Retours:

Liste des expressions à écouter.

getLocalTimestamp

public OffsetDateTime getLocalTimestamp()

Obtient la date et l’heure locales du message, exprimées au format ISO-8601. Par exemple, 2016-09-23T13:07:49.4714686-07:00.

Retours:

Horodatage local de l’activité.

getLocalTimezone

public String getLocalTimezone()

Obtient le nom du fuseau horaire local du message, exprimé au format de base de données de fuseau horaire IANA. Par exemple, l’Amérique/Los_Angeles.

Retours:

Fuseau horaire local.

getLocale

public String getLocale()

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 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.

Retours:

Paramètres régionaux de contenu.

getMembersAdded

public List getMembersAdded()

Obtient la collection de membres ajoutés à la conversation.

Retours:

Liste des ChannelAccount des membres ajoutés.

getMembersRemoved

public List getMembersRemoved()

Obtient la collection de membres supprimés de la conversation.

Retours:

Liste des ChannelAccount des membres supprimés.

getMentions

public List getMentions()

Résout les mentions des entités de cette activité. Cette méthode est définie sur la classe Activity, mais elle est destinée uniquement à être utilisée avec une activité de message, où l’activité Activity#type est définie sur MESSAGE.

Retours:

Tableau de mentions ; ou un tableau vide, si aucun tableau n’est trouvé.

getName

public String getName()

Obtient le nom de l’opération associée à une activité d’appel ou d’événement.

Retours:

Nom de l’activité.

getProperties

public Map getProperties()

Contient les propriétés de dépassement de capacité qui ne sont pas des propriétés de première classe dans l’objet. Cela permet l’extensibilité tout en conservant l’objet.

Retours:

Mappage des propriétés supplémentaires.

getReactionsAdded

public List getReactionsAdded()

Obtient la collection de réactions ajoutées à la conversation.

Retours:

Liste des MessageReaction.

getReactionsRemoved

public List getReactionsRemoved()

Obtient la collection de réactions supprimées de la conversation.

Retours:

Liste des MessageReaction.

getRecipient

public ChannelAccount getRecipient()

Identifie le destinataire du message.

Retours:

ChannelAccount du destinataire.

getRelatesTo

public ConversationReference getRelatesTo()

Référence à une autre conversation ou activité.

Retours:

Référence de conversation.

getReplyConversationReference

public ConversationReference getReplyConversationReference(ResourceResponse reply)

Créez une conversationReference basée sur les informations de conversation de cette activité et resourceResponse à partir de l’envoi d’une activité.

Paramètres:

reply - ResourceResponse retourné par sendActivity.

Retours:

ConversationReference qui peut être stockée et utilisée ultérieurement pour supprimer ou mettre à jour l’activité.

getReplyToId

public String getReplyToId()

Obtient l’ID du message auquel ce message est une réponse.

Retours:

Réponse à l’ID.

getServiceUrl

public String getServiceUrl()

Définit l’URL qui spécifie le point de terminaison de service du canal. Défini par le canal.

Retours:

URL du service.

getSpeak

public String getSpeak()

Texte à parler.

Retours:

Texte SSML à parler.

getSuggestedActions

public SuggestedActions getSuggestedActions()

Obtient les actions suggérées pour l’activité.

Retours:

SuggestionActions pour l’activité.

getSummary

public String getSummary()

Obtient le texte à afficher si le canal ne peut pas afficher les cartes.

Retours:

Texte de synthèse.

getText

public String getText()

Obtient le contenu texte du message.

Retours:

Contenu du texte.

getTextFormat

public TextFormatTypes getTextFormat()

Format des champs de texte Par défaut :markdown. Les valeurs possibles sont les suivantes : 'markdown', 'plain', 'xml'.

Retours:

Type TextFormatTypes.

getTextHighlights

public List getTextHighlights()

Obtient la collection de fragments de texte à mettre en surbrillance lorsque l’activité contient une valeur ReplyToId.

Retours:

Liste des TextHighlight.

getTimestamp

public OffsetDateTime getTimestamp()

Obtient la date et l’heure à laquelle le message a été envoyé, au format UTC, exprimé au format ISO-8601.

Retours:

Horodatage UTC de l’activité.

getTopicName

public String getTopicName()

Obtient le nom de la rubrique mise à jour de la conversation.

Retours:

Nom de la rubrique.

getType

public String getType()

Obtient la ActivityTypes de l’activité.

Retours:

Type d’activité.

getValue

public Object getValue()

Obtient la valeur associée à l’activité.

Retours:

Valeur d’activité.

getValueType

public String getValueType()

Obtient le type de l’objet valeur de l’activité.

Retours:

Type valeur.

hasContent

public boolean hasContent()

Vérifie si cette activité (message) a du contenu.

Retours:

Retourne la valeur true, si ce message contient du contenu à envoyer. False sinon.

isActivity

protected boolean isActivity(String activityType)

True si l’activité est du type d’activité spécifié.

Paramètres:

activityType - Type à comparer.

Retours:

true si l’activité est du type spécifique.

isFromStreamingConnection

public Boolean isFromStreamingConnection()

Détermine si l’activité a été envoyée via une connexion Http/Https ou streaming, cela 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.

Retours:

True si l’activité provient d’une connexion de diffusion en continu.

isTeamsActivity

public boolean isTeamsActivity()

Vérifiez si cette action provient de microsoft teams.

Retours:

true si l’activité provient de microsoft teams.

isType

public boolean isType(String compareTo)

Méthode pratique à retourner si l’activité est du type spécifié.

Paramètres:

compareTo - Type à comparer.

Retours:

True si l’activité est du type spécifié.

removeMentionText

public String removeMentionText(String withId)

Supprimez tout texte de mention pour l’ID donné de la propriété Activity.Text. Par exemple, étant donné le message « @echoBot Hi Bot », cela supprime « @echoBot », en laissant « Hi Bot ». En règle générale, cela serait utilisé pour supprimer le texte de mention pour le destinataire cible (le bot généralement), bien qu’il puisse être appelé pour chaque membre. Par exemple : turnContext.Activity.RemoveMentionText(turnContext.Activity.Recipient.Id) ; Le format d’une mention Activity.Entity dépend du canal. Toutefois, dans tous les cas, nous attendons que le fichier Mention.Text contienne le texte exact de l’utilisateur tel qu’il apparaît dans Activity.Text. Par exemple, Teams utilise le nom d’utilisateur, tandis que slack utilise @username. Il est attendu que le texte se trouve dans Activity.Text et que cette méthode supprime cette valeur de Activity.Text.

Paramètres:

withId - Id de mention à mettre en correspondance.

Retours:

nouvelle valeur de propriété Activity.Text.

removeMentionTextImmutable

public static String removeMentionTextImmutable(Activity activity, String id)

Supprime la mention de Activity.Text sans modifier l’activité.

Paramètres:

activity - Activité sur laquelle supprimer le texte de mention.
id - ID du destinataire.

Retours:

Activity.Text avec la mention supprimée.

removeRecipientMention

public String removeRecipientMention()

Supprimez le texte de mention du destinataire de la propriété Text. Utilisez la prudence, car cette fonction modifie le texte de l’activité.

Retours:

Nouveau. Valeur de propriété textuel.

removeRecipientMentionImmutable

public static String removeRecipientMentionImmutable(Activity activity)

Supprime la mention du destinataire sans modifier l’activité.

Paramètres:

activity - Activité à partir de laquelle supprimer les mentions.

Retours:

Activity.Text avec mentions supprimées.

setAction

public void setAction(String withAction)

Indique si le destinataire d’un contactRelationUpdate a été ajouté ou supprimé de la liste de contacts de l’expéditeur.

Paramètres:

withAction - Action du destinataire.

setAttachment

public void setAttachment(Attachment withAttachment)

Définit une pièce jointe unique sur l’activité.

Paramètres:

withAttachment - Objet Attachment.

setAttachmentLayout

public void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)

Définit l’indicateur de disposition pour plusieurs pièces jointes.

Paramètres:

withAttachmentLayout - Type de pièce jointe.

setAttachments

public void setAttachments(List withAttachments)

Définit les pièces jointes à l’activité.

Paramètres:

withAttachments - Liste des Attachment.

setCallerId

public void setCallerId(String withCallerId)

Définit l’IRI identifiant l’appelant d’un bot. Ce champ n’est pas destiné à être transmis via le réseau, mais il est plutôt rempli par des bots et des clients basés sur des données vérifiables par chiffrement qui affirment l’identité des appelants (par exemple, des jetons).

Paramètres:

withCallerId - ID de l’appelant.

setChannelData

public void setChannelData(Object withChannelData)

Définit le contenu spécifique au canal.

Paramètres:

withChannelData - Canaliser des données spécifiques en tant que JsonNode.

setChannelId

public void setChannelId(String withChannelId)

Définit l’ID qui identifie de manière unique le canal. Défini par le canal.

Paramètres:

withChannelId - ID de canal.

setCode

public void setCode(EndOfConversationCodes withCode)

Définit le code des activités endOfConversation qui indique pourquoi la conversation s’est terminée.

Paramètres:

withCode - Code endOfConversation.

setConversation

public void setConversation(ConversationAccount withConversation)

Identifie la conversation à laquelle appartient l’activité.

Paramètres:

withConversation - Le ConversationAccount.

setDeliveryMode

public void setDeliveryMode(String withDeliveryMode)

Indicateur de remise pour signaler au destinataire d’autres chemins de remise de l’activité.

Le mode de remise par défaut est \"default\ ».

Paramètres:

withDeliveryMode - Indicateur du mode de remise.

setEntities

public void setEntities(List withEntities)

Définit la version de charge utile des entités dans une activité.

Paramètres:

withEntities - Entités de charge utile.

setExpiration

public void setExpiration(LocalDateTime withExpiration)

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.

Paramètres:

withExpiration - Expiration de l’activité.

setFrom

public void setFrom(ChannelAccount withFrom)

Identifie l’expéditeur du message.

Paramètres:

withFrom - ChannelAccount de l’expéditeur.

setHistoryDisclosed

public void setHistoryDisclosed(boolean withHistoryDisclosed)

Définit si l’historique précédent du canal est divulgué.

Paramètres:

withHistoryDisclosed - True si l’historique est divulgué.

setId

public void setId(String withId)

Définit l’ID qui identifie de manière unique l’activité sur le canal.

Paramètres:

withId - ID d’activité.

setImportance

public void setImportance(String withImportance)

Définit l’importance de l’activité.

Paramètres:

withImportance - Importance de l’activité.

setInputHint

public void setInputHint(InputHints withInputHint)

Indique si votre bot accepte, attend ou ignore l’entrée de l’utilisateur une fois le message remis au client.

Paramètres:

withInputHint - Indicateur d’entrée pour l’activité.

setLabel

public void setLabel(String withLabel)

Définit l’étiquette descriptive de l’activité.

Paramètres:

withLabel - Étiquette d’activité.

setListenFor

public void setListenFor(List withListenFor)

Définit la liste des expressions et références que les systèmes d’amorçage de parole et de langue doivent écouter.

Paramètres:

withListenFor - Liste des expressions à écouter.

setLocalTimeZone

public void setLocalTimeZone(String withLocalTimezone)

Définit le nom du fuseau horaire local du message, exprimé au format de base de données de fuseau horaire IANA. Par exemple, l’Amérique/Los_Angeles.

Paramètres:

withLocalTimezone - Fuseau horaire local.

setLocalTimestamp

public void setLocalTimestamp(OffsetDateTime withLocalTimestamp)

Contient la date et l’heure locales du message, exprimées au format ISO-8601. Par exemple, 2016-09-23T13:07:49.4714686-07:00.

Paramètres:

withLocalTimestamp - Horodatage local de l’activité.

setLocale

public void setLocale(String withLocale)

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 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.

Paramètres:

withLocale - Paramètres régionaux de contenu.

setMembersAdded

public void setMembersAdded(List withMembersAdded)

Définit la collection de membres ajoutés à la conversation.

Paramètres:

withMembersAdded - Liste des ChannelAccount des membres ajoutés.

setMembersRemoved

public void setMembersRemoved(List withMembersRemoved)

Définit la collection de membres supprimés de la conversation.

Paramètres:

withMembersRemoved - Liste des ChannelAccount des membres supprimés.

setMentions

public void setMentions(List withMentions)

Définit la version de charge utile des mentions dans une activité.

Paramètres:

withMentions - Entités de charge utile.

setName

public void setName(String withName)

Définit le nom de l’opération associée à une activité d’appel ou d’événement.

Paramètres:

withName - Nom de l’activité.

setProperties

public void setProperties(String key, JsonNode withValue)

Contient les propriétés de dépassement de capacité qui ne sont pas des propriétés de première classe dans l’objet. Cela permet l’extensibilité tout en conservant l’objet.

Paramètres:

key - Clé de la propriété à définir.
withValue - Valeur de la propriété.

setReactionsAdded

public void setReactionsAdded(List withReactionsAdded)

Définit la collection de réactions ajoutées à la conversation.

Paramètres:

withReactionsAdded - Liste des MessageReaction.

setReactionsRemoved

public void setReactionsRemoved(List withReactionsRemoved)

Définit la collection de réactions supprimées de la conversation.

Paramètres:

withReactionsRemoved - Liste des MessageReaction.

setRecipient

public void setRecipient(ChannelAccount withRecipient)

Identifie le destinataire du message.

Paramètres:

withRecipient - ChannelAccount du destinataire.

setRelatesTo

public void setRelatesTo(ConversationReference withRelatesTo)

Référence à une autre conversation ou activité.

Paramètres:

withRelatesTo - Référence de conversation.

setReplyToId

public void setReplyToId(String withReplyToId)

Définit l’ID du message auquel ce message est une réponse.

Paramètres:

withReplyToId - Réponse à l’ID.

setServiceUrl

public void setServiceUrl(String withServiceUrl)

Définit l’URL qui spécifie le point de terminaison de service du canal. Défini par le canal.

Paramètres:

withServiceUrl - URL du service de l’activité.

setSpeak

public void setSpeak(String withSpeak)

Définit le texte à parler.

Paramètres:

withSpeak - Texte SSML à parler.

setSuggestedActions

public void setSuggestedActions(SuggestedActions withSuggestedActions)

Actions suggérées pour l’activité.

Paramètres:

withSuggestedActions - SuggestionActions pour l’activité.

setSummary

public void setSummary(String withSummary)

Définit le texte à afficher si le canal ne peut pas afficher les cartes.

Paramètres:

withSummary - Texte de synthèse.

setText

public void setText(String withText)

Définit le contenu texte du message.

Paramètres:

withText - Contenu du texte.

setTextFormat

public void setTextFormat(TextFormatTypes withTextFormat)

Format des champs de texte.

Paramètres:

withTextFormat - Type TextFormatTypes.

setTextHighlights

public void setTextHighlights(List withTextHighlights)

Définit la collection de fragments de texte à mettre en surbrillance lorsque l’activité contient une valeur ReplyToId.

Paramètres:

withTextHighlights - Liste des TextHighlight.

setTimestamp

public void setTimestamp(OffsetDateTime withTimestamp)

Définit la date et l’heure à laquelle le message a été envoyé, au format UTC, exprimé au format ISO-8601.

Paramètres:

withTimestamp - Horodatage UTC de l’activité.

setTopicName

public void setTopicName(String withTopicName)

Définit le nom de la rubrique mise à jour de la conversation.

Paramètres:

withTopicName - Nom de la rubrique.

setType

public void setType(String withType)

Définit la ActivityTypes de l’activité.

Paramètres:

withType - Type de l’activité.

setValue

public void setValue(Object withValue)

Définit la valeur associée à l’activité.

Paramètres:

withValue - Valeur d’activité.

setValueType

public void setValueType(String withValueType)

Définit le type de l’objet valeur de l’activité.

Paramètres:

withValueType - Type de valeur d’activité.

teamsGetChannelData

public TeamsChannelData teamsGetChannelData()

Obtient TeamsChannelData.

Retours:

TeamsChannelData

teamsGetChannelId

public String teamsGetChannelId()

Obtenir un identificateur unique représentant un canal.

Retours:

S’il s’agit d’une activité Teams avec des données valides, identificateur unique représentant un canal.

teamsGetMeetingInfo

public TeamsMeetingInfo teamsGetMeetingInfo()

Obtient l’objet TeamsMeetingInfo de l’activité actuelle.

Retours:

Réunion de l’équipe de l’activité actuelle ou null.

teamsGetTeamId

public String teamsGetTeamId()

Obtenir un identificateur unique représentant une équipe.

Retours:

S’il s’agit d’une activité Teams avec des données valides, identificateur unique représentant une équipe.

teamsGetTeamInfo

public TeamInfo teamsGetTeamInfo()

Obtenir des données TeamInfo Teams.

Retours:

S’il s’agit d’une activité Teams avec des données valides, l’objet TeamInfo.

teamsNotifyUser

public void teamsNotifyUser()

Définit la valeur de notification dans TeamsChannelData sur true.

teamsNotifyUser

public void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)

Définit la notification d’une réunion dans TeamsChannelData.

Paramètres:

alertInMeeting - True s’il s’agit d’une alerte de réunion.
externalResourceUrl - URL de ressource externe.

S’applique à