Get Channels

概要

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
Required	はい
既定値	Get Channels
許容値	String または String 型変数を入力します。
備考	N/A

入力

TeamId

チャネルの取得に使用する Team オブジェクトの ID です。

属性	詳細
入力	String
Required	はい
既定値	空
許容値	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)

その他

プライベート (Private)

選択すると、変数と引数の値が Verbose レベルでログ記録されなくなります。

属性	詳細
入力	チェックボックス
Required	いいえ
既定値	非選択
許容値	選択または非選択
備考	N/A

オプション

クエリ オプション

チャネルのリストの取得時に適用する検索パラメーター。

属性	詳細
入力	QueryOption[] (OData 構文)
Required	いいえ
既定値	空
許容値	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'")} .

出力

Channels

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

属性	詳細
入力	Channel[]
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合は必須)
既定値	空
許容値	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.