获取频道

概述

Using your search parameters (QueryOptions) and specified team (TeamId), the Get Channels activity calls the Microsoft Graph ListChannels API to retrieve the channels that match your query.

After retrieving the channels, the activity returns its properties and relationships in a Channel[] object (Channels) that you can use as input variables in subsequent activities (for example, Channel(0).Id in Get Messages, Send Message, and so on).

工作方式

The following steps and message sequence diagram is an example of how the activity works from design time (that is, the activity dependencies and input/output properties) to run time.

1. 完成设置步骤。
2. Add the Microsoft Teams Scope activity to your project.
3. Add an activity or run an external process that outputs a Team.Id value (e.g., Get Teams).
4. Add the Get Channels activity inside the Microsoft Teams Scope activity.
5. （可选）为输入属性输入值。
6. Create and enter a Channel[] variable for your Output property.
7. 运行活动。

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

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

     

属性

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

常见

显示名称

活动的显示名称。

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

输入

团队 ID

要从中检索频道的 Team 对象的 ID。

属性	详细信息
类型	String
必填	是
默认值	空白
允许的值	输入 String 或 String 变量。
注意	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)

其他

私有

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

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

选项

查询选项

要在检索频道列表时应用的搜索参数。

属性	详细信息
类型	QueryOption[] （OData 语法）
必填	否
默认值	空白
允许的值	输入 QueryOption[] 或 QueryOption 变量。
注意	Enter your value using an OData system query option ; the format is as follows: _{New QueryOption("Option", "OptionParameter")} . For example, if you want to apply the $filter option, you would enter "filter" as the first string and then enter a filter parameter as the second string (e.g., {New QueryOption("filter", "displayName ne 'General'")} .

输出

频道

An array of channels (Channel[] object) that match QueryOptions value.

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

示例

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

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