メッセージを取得

概要

[メッセージを取得] アクティビティは、Microsoft Graph の ListChatMessages または List ChannelMessages API を呼び出します

をクリックし、指定したチャット (ChatId) またはチャンネル (ChannelId) とチーム (TeamID) からすべてのメッセージを取得します。

検索の実行後、アクティビティはプロパティを ChatMessage[] オブジェクト ([メッセージ]) で出力します。これは、後続のアクティビティで入力変数として使用できます (例: [メッセージに返信を取得]、[ メッセージに 返信]などの ChatMessage(0).Id )。

動作のしくみ

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

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [Microsoft Teams スコープ] アクティビティを追加します。
3. 次の 2 つのオプション (A または B) のいずれかを完了します。

A。 Chat.Id の値を出力するアクティビティを追加するか外部プロセスを実行します (例: [チャットを取得])。

B。 Team.Id の値を出力するアクティビティを追加するか外部プロセスを実行します (例:[チームを取得])。また、 Channel.Id 値を出力するアクティビティまたは外部プロセス (例: [チャンネルを取得])。

1. [ Microsoft Teams スコープ] アクティビティ内に [ メッセージを取得 ] アクティビティを追加します。
2. [ チャンネル ] または [ チャット ] プロパティの値を入力します。
3. [ 出力] セクションのプロパティのために ChatMessage[] 変数を作成し、入力します。

4. アクティビティを実行します。

   • 入力したプロパティ値は、 ListChatMessages または ListChannelMessages API に渡されます。
   • API は、[出力] セクションのプロパティ変数に ChatMessage[] の値を返します。
     
     

     

     
     

プロパティ

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

共通

表示名

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

属性	詳細
入力	String
Required	はい
既定値	メッセージを取得
許容値	String または String 型変数を入力します。
備考	N/A

Channel

TeamId

メッセージの取得に使用するチャネルを含む Team オブジェクトの ID です。

属性	詳細
入力	String
Required	はい ( ChatId が空の場合)
既定値	空
許容値	String または String 型変数を入力します。
備考	Team.Id の値を取得するには、出力に Team.Id の値を含む外部プロセスまたはアクティビティを使用します (例: [チームを取得 ] または [外部 API 呼び出し])。 (チャット ID) または (チーム ID とチャネル ID) が必要です。

ChannelId

メッセージの取得に使用する Channel オブジェクトの ID です。

属性	詳細
入力	String
Required	はい ( チーム ID に値がある場合)
既定値	空
許容値	String または String 型変数を入力します。
備考	Channel.Id 値を取得するには、出力に Channel.Id 値を含む外部プロセスまたはアクティビティを使用します (例: [チャンネルを取得] または [外部 API 呼び出し])。 (チャット ID) または (チーム ID とチャネル ID) が必要です。

チャット

ChatId

メッセージの取得に使用する Chat オブジェクトの ID です。

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

オプション

上限量

取得する最近使用したメッセージの最大数。

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

その他

プライベート (Private)

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

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

出力

Messages

指定したチャットまたはチャネルからのメッセージの配列 (ChatMessage[] オブジェクト)。

属性	詳細
入力	ChatMessage[]
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合は必須)
既定値	空
許容値	ChatMessage[] 型変数を入力します。
備考	このプロパティ用に作成した変数は、後続のアクティビティ ([ メッセージに返信を取得]、[メッセージに 返信] などの ChatMessage(0).Id ) で入力変数として使用できます。 * この変数を入力プロパティの値として使用する場合、配列内の使用する項目を指定します (例: myMessages(0))。 ChatMessage オブジェクトには、他のアクティビティで使用できる複数のプロパティが含まれます。下の画像の例に、返すことができるプロパティの一部を示します。 注 - デザイナーに表示されている一部のプロパティは、 ChatMessage オブジェクトには適用されません (例: ODatatType)。 適用できる Team プロパティのリストは、上記のリンクから確認できます。

例

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

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