Get message

Überblick

The Get Message activity calls the Microsoft Graph GetChannelMessage or GetChatMessage API to retrieve a specified message (MessageId) from a chat (ChatId) or channel (ChannelId) and team (TeamID).

After performing the search, the activity outputs its properties in a ChatMessage object (Message) that you can use as input variables in subsequent activities (for example, ChatMessage.Id in Get Message Replies, Reply To Message, and so on).

The difference between this activity and the Get Messages activity is the requirement to input of a specific message (MessageId). Inputting the MessageId enables you to retrieve a specific ChatMessage object instead of an array of objects that gets returned in the Get Messages activity.

Wie es funktioniert

Die folgenden Schritte und das folgende Nachrichtensequenzdiagramm sind ein Beispiel dafür, wie die Aktivität von der Entwurfszeit (d. h. den Aktivitätsabhängigkeiten und Eingabe-/Ausgabeeigenschaften) bis zur Laufzeit funktioniert.

1. Schließen Sie die Einrichtungsschritte ab.
2. Add the Microsoft Teams Scope activity to your project.
3. Complete one of the following two options (A or B):

A. Add an activity or run an external process that outputs a Chat.Id value (e.g., Get Chats).

B. Add an activity or run an external process that outputs a Team.Id value (for example, Get Teams) AND an activity or external process that outputs a Channel.Id value (for example, Get Channels).

1. Add the Get Message activity inside the Microsoft Teams Scope activity.
2. Enter values for the Channel OR Chat and Input properties.
3. Create and enter a ChatMessage variable for your Output property.
4. Führen Sie die Aktivität aus.

   • Your input property values are sent to the GetChannelMessage or GetChatMessage API.

   • Die API gibt den Wert ChatMessage an Ihre Ausgabeeigenschaftsvariable zurück.

     

Eigenschaften

Die Werte für die folgenden Eigenschaften werden beim Hinzufügen dieser Aktivität zu Ihrem Projekt in UiPath Studio angegeben.

Allgemein

DisplayName

Der Anzeigename der Aktivität.

Attribute	Details
Typ	String
Erforderlich	Ja
Standardwert	Get Messages
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	Keine Angabe

Kanal

Team ID

Die ID des Team -Objekts, das den Kanal enthält, von dem Sie Nachrichten abrufen möchten.

Attribute	Details
Typ	String
Erforderlich	Yes (if ChatId is empty)
Standardwert	Leer
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	To get the Team.Id value, use an external process or activity that includes the Team.Id value in its output (for example, Get Teams or external API call) Either (ChatId) or (TeamId and ChannelId) are required.

Channel ID

Die ID des Channel -Objekts, von dem Sie die Nachricht abrufen möchten.

Attribute	Details
Typ	String
Erforderlich	Yes (if TeamId has a value)
Standardwert	Leer
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	To get the Channel.Id value, use an external process or activity that includes the Channel.Id value in its output (for example, Get Channels or external API call) Either (ChatId) or (TeamId and ChannelId) are required.

Chat

ChatId

Die ID des Chat -Objekts, an das Sie die Nachricht senden möchten.

Attribute	Details
Typ	String
Erforderlich	Yes (if TeamId and ChannelId are empty)
Standardwert	Leer
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	To get the Chat.Id value, use an external process or activity that includes the Chat.Id value in its output (for example, Get Chats or external API call) Either (ChatId) or (TeamId and ChannelId) are required.

Eingabe

NachrichtenID

Die ID der Nachricht, die Sie abrufen möchten.

Attribute	Details
Typ	String
Erforderlich	Ja
Standardwert	Leer
Zulässige Werte	Geben Sie eine String oder String -Variable ein.
Hinweise	To get the Message.Id value, use an external process or activity that includes the Message.Id value in its output (for example, Get Messages or external API call).

Sonstiges

Private

Falls ausgewählt werden die Werte von Variablen und Argumenten nicht mehr auf ausführlicher Ebene protokolliert.

Attribute	Details
Typ	Kontrollkästchen
Erforderlich	Nein
Standardwert	nicht ausgewählt
Zulässige Werte	Ausgewählt oder nicht ausgewählt
Hinweise	Keine Angabe

Ausgabe

Meldung

The ChatMessage object that represents the message specified in the MessageId property.

Attribute	Details
Typ	ChatMessage
Erforderlich	Nein (erforderlich, wenn Sie die Ausgabedaten in nachfolgenden Aktivitäten verwenden möchten)
Standardwert	Leer
Zulässige Werte	Geben Sie eine ChatMessage -Variable ein.
Hinweise	The variable you create for this property can be used as an input variable in subsequent activities (e.g., Get Message Replies , Reply To Message , etc.). The ChatMessage object includes multiple properties that you can use in other activities.The example image below shows some of the properties that you can return. Note - some properties listed in the designer are not applicable to the ChatMessage object (e.g., ODatatType ). For a list of the applicable Team properties, visit the links above.

Beispiel

Die folgende Abbildung zeigt ein Beispiel für die Aktivitätsabhängigkeitsbeziehung und Eingabe-/Ausgabe-Eigenschaftswerte.

For step-by-step instructions and examples, see the Quickstart guides.