Get Chat

概要

[ チャットを取得] アクティビティは、Microsoft Graph の GetChat API を呼び出して、指定したチャット ([チャット ID]) のプロパティを取得します。

チャットを取得した後、アクティビティはプロパティを Chat オブジェクト (チャット) に返します。このオブジェクトは、後続のアクティビティ (例: [ メッセージを取得]、[ メッセージを送信]) で入力変数として使用できます。

ユーザーがメンバーになっているチャットのリスト (Chat[]を返す [チャットを取得] アクティビティとは異なり、[チャットを取得] アクティビティは、提供された ChatId を使用して、指定された単一のチャット (Chat) を取得します。ChatId がない場合は、[チャットを取得] アクティビティを使用して同じチャットのプロパティを取得できます。

動作のしくみ

以下の手順とメッセージ シーケンス ダイアグラムは、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作のしくみの例を示したものです。

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [ Microsoft Teams スコープ ] アクティビティを追加します。
3. アクティビティを追加するか、 Chat.Id 値を出力する外部プロセスを実行します (例: [チャットを取得])。
4. [Microsoft Teams スコープ] アクティビティ内に [チャットを取得] アクティビティを追加します。
5. [入力] セクションのプロパティに値を入力します。
6. [出力] セクションのプロパティのために Chat 型変数を作成し、入力します。
7. アクティビティを実行します。

   • 入力したプロパティ値は、 GetChat API に渡されます。

   • API は、[出力] セクションのプロパティ変数に Chat の値を返します。

     

プロパティ

以下のプロパティの値は、このアクティビティを UiPath Studio でプロジェクトに追加するときに指定します。

共通

表示名

アクティビティの表示名です。

属性	詳細
入力	String
Required	はい
既定値	Get Chat
許容値	String または String 型変数を入力します。
備考	N/A

入力

ChatId

取得するチャットの ID です。

属性	詳細
入力	String
Required	はい
既定値	空
許容値	String または String 型変数を入力します。
備考	Chat.Id値を取得するには、出力に Chat.Id 値を含む外部プロセスまたはアクティビティを使用します (例: チャットを取得または外部 API 呼び出し)。

その他

プライベート (Private)

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

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

出力

チャット

取得したチャットを表す Chat オブジェクト。

属性	詳細
入力	Chat
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合は必須)
既定値	空
許容値	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. 注 - デザイナーに表示されている一部のプロパティは、 Chat オブジェクトには適用されません (例: ODatatType)。 適用できる Team プロパティのリストは、上記のリンクから確認できます。

例

次の画像は、アクティビティの依存関係と入力/出力プロパティの値の例です。

ステップバイステップの手順および例は、「クイックスタート」ページをご覧ください。