検索

UiPath.Slack.Activities.Channels.Search

概要

[検索] アクティビティは、Slack の search.all API を使用して、検索パラメーター ([クエリ]) に一致するメッセージやファイルを検索します。検索パラメーターは、Slack アプリケーションで検索する場合に使用するものと同じ修飾子 (例: "in:#channel-name, in:@user.name, keyword") に従います。詳細については、Slack のヘルプ ドキュメントの「Slack 内の検索方法」をご覧ください。

検索の実行後、アクティビティは一致する Message オブジェクト ([FirstMessage] と [メッセージ]) および SlackFile ([FirstFile] と [ファイル]) オブジェクトを返します。このオブジェクトは、後続のアクティビティ (例: [ファイルをダウンロード]) で入力変数として使用できます。

動作のしくみ

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

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [Slack スコープ] アクティビティを追加します。
3. [Slack スコープ] アクティビティ内に [検索] アクティビティを追加します。
4. [入力] セクションのプロパティに値を 入力 します。

5. [出力] セクションのプロパティのために以下の変数を作成し、入力します。

   • SlackFile[] および SlackFile
   • Message[] および Message

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

   • 入力プロパティ値は、search.all API に渡されます。
   • API は、出力プロパティ変数に SlackFile、SlackFile[]、Message、および Message[] の値を返します。
     
     

     

     
     

アクティビティの本体

• クエリ - 検索パラメーター (例: チャンネル、ユーザー、キーワード) です。このフィールドでは Strings 型または String 型変数のみがサポートされます。
• 結果の最大数 - Message および SlackFile 配列で返される結果の最大数です。このフィールドでは、Int32 または Int32 型の変数のみがサポートされています。

• SortBy - 結果が返される際の並べ替え方法を指定します。[関連度順]、[新しい順]、[古い順] の 3 つのオプションから選択します。3 つのオプションはそれぞれに従って並べ替えられます。

  • 関連度順 - クエリに最も一致するコンテンツを含むメッセージとファイルです。
  • 新しい順 - クエリに一致するコンテンツを含む最新のメッセージとファイルです。
  • 古い順 - クエリに一致するコンテンツを含む最も古いメッセージとファイルです。
• ファイル - [クエリ] の値に一致するコンテンツを含むファイルです。File[] 型変数を入力します。
• メッセージ - [クエリ] の値に一致するコンテンツを含むメッセージです。Message[] 型変数を入力します。
  • メッセージが見つからない場合、空の配列が返されます。
  • Message オブジェクトには、ファイル情報も含まれます。Message オブジェクトを使用してファイルをダウンロードするには、その File プロパティ (例: item.File(0)) を取得します。
  • このアクティビティを使用して配列の出力を処理する予定の場合は、[TypeArgument] として [UiPath.Slack.Models.Message] を選択します。

プロパティ

共通

• 表示名 - アクティビティの表示名です。 このフィールドでは Strings 型または String 型変数のみがサポートされます。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

出力

• 応答ステータス - 要求のステータスです (成功/失敗に関する情報)。 ResponseStatus 型変数を入力します (UiPath.BAF.Models.ResponseStatus)。 ResponseStatus オブジェクトには、他のアクティビティで使用できる 3 つのプロパティが含まれています。
  • Success - Boolean - API 要求が成功したかどうかを示します。
  • ErrorCode - String - API 要求が成功しなかった場合の応答エラーです (Success=False)。
  • Message - String - エラー メッセージです。

例

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

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