获取聊天

概述

The Get Chat activity calls the Microsoft Graph GetChat API to retrieve the properties of a specified chat (ChatId).

After retrieving the chat, the activity returns its properties in a Chat object (Chat) that you can use as an input variable in subsequent activities (e.g., Get Messages, Send Message, etc.).

Unlike the Get Chats activity, which returns a list of chats the user is a member of (Chat[]), the Get Chat activity retrieves a single, specified chat (Chat) using the provided ChatId. If you don't have the ChatId, you can use the Get Chats activity to get the same chat properties.

工作方式

以下步骤和消息序列图是活动从设计时（即活动依赖项和输入/输出属性）到运行时如何工作的示例。

1. 完成设置步骤。
2. Add the Microsoft Teams Scope activity to your project.
3. Add an activity or run an external process that outputs a Chat.Id value (e.g., Get Chats).
4. Add the Get Chat activity inside the Microsoft Teams Scope activity.
5. Enter a value for the Input property.
6. Create and enter a Chat variable for your Output property.
7. 运行活动。

   • Your input property values are sent to the GetChat API.

   • API 会将 Chat 值返回到您的输出属性变量。

     

属性

将此活动添加到 UiPath Studio 中的项目时，会指定以下属性的值。

常见

显示名称

活动的显示名称。

属性	详细信息
类型	String
必填	是
默认值	获取聊天
允许的值	输入 String 或 String 变量。
注意	不适用

输入

ChatId

要检索的聊天 ID。

属性	详细信息
类型	String
必填	是
默认值	空白
允许的值	输入 String 或 String 变量。
注意	To get the Chat.Id value, use an external process or activity that includes the Chat.Id value in its output (e.g., Get Chats or external API call).

其他

私有

如果已选择，变量和参数的值将不会在 Verbose 级进行记录。

属性	详细信息
类型	复选框
必填	否
默认值	未选中
允许的值	已选择或未选择
注意	不适用

输出

聊天

表示检索到的聊天的 Chat 对象。

属性	详细信息
类型	Chat
必填	否（如果您计划在后续活动中使用输出数据，则为必填项）
默认值	空白
允许的值	输入Chat变量。
注意	The variable you create for this property can be used as an input variable in subsequent activities (e.g., Get Messages , Send Message , etc.). The Chat object includes multiple properties and 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 Chat object (e.g., ODatatType ). For a list of the applicable Team properties, visit the links above.

示例

下图显示了活动依赖关系和输入/输出属性值的示例。

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