イベント/予定を検索

UiPath.MicrosoftOffice365.Activities.Calendar.SearchEvents

説明

Microsoft Graph の List Events API を使用して、指定した予定表 ([予定表]) から、一致するイベントを取得します。[予定表] プロパティが空のままの場合、アクティビティは既定の予定表でイベントを検索します。

検索の実行後、アクティビティは一致する Event[] オブジェクト ([イベント]) を返します。この出力は、後続のアクティビティ ([イベント/予定を変更]、[場所を追加] など) で入力変数として使用できます。

スコープ

このアクティビティには、次のスコープが必要です。

• Calendars.ReadWrite

OR

• Calendars.ReadWrite.Shared

プロジェクトの対応 OS

Windows - レガシ |Windows

構成

プロパティ

共通

• 表示名 - アクティビティの表示名です。 このプロパティは、String 型変数と文字列形式の値をサポートします。

入力

• アカウント - (任意) 対話するメール アドレスです。現在のユーザーがアクセス権を持つ任意の共有メールボックスを含みます。設定しない場合、現在のユーザーのアカウントが使用されます。 このプロパティは、String 型変数と文字列形式の値をサポートします。
  注: [アカウント] フィールドは、認証の種類が [ApplicationIdAndSecret] の場合は必須です。
• 予定表 ｰ 検索する予定表です。[予定表を取得] アクティビティによって取得できます。値を指定しないと、既定の予定表が使用されます。このフィールドでは Calendar 変数のみをサポートします。値を入力する場合、[予定表を取得] アクティビティの出力プロパティ変数 ([予定表] または [既定の予定表]) を使用します。[予定表] 出力プロパティ変数を使用する場合、配列内の使用する項目を指定します (例: myCalendar(0))。

その他

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

オプション

• 終了日 ｰ イベント検索範囲の終了日です。指定すると、この日付よりも前に発生するイベントのみが返されます (この日に発生するイベントは検索されません)。このフィールドでは DateTime 型の変数のみがサポートされています。DateTime の値は、MM/DD/YYYY の形式で指定する必要があります (例: 11/01/2019)。
• イベント ID - 検索する予定の ID です。指定した場合、[アカウント] パラメーターは考慮されますが、[オプション] カテゴリのフィルター パラメーターは無視されます。指定した ID の予定が見つかった場合、出力配列には正確に 1 つの要素が含まれます。見つからなかった場合、このアクティビティは例外をスローします。 このプロパティは、String 型変数と文字列形式の値をサポートします。
• 結果の最大数 ｰ 検索結果として返されるイベントの最大数です。このフィールドでは整数および Int32 型の変数のみがサポートされています。 既定値は 50 です。
• 定期的なイベントを返す ｰ 選択した場合、定期的なイベントも返されます。このフィールドでは、Boolean 値がサポートされています。
• 検索クエリ ｰ 指定すると、件名、本文、場所、または出席者にこの文字列が含まれるイベントのみが返されます。OData クエリ パラメーターを使用した String を入力するか、イベントのタイトル (例: Office365-Quickstart) を入力します。
• 開始日 ｰ イベント検索範囲の開始日です。指定すると、この日付よりも後に発生するイベントのみが返されます (この日に発生するイベントは検索されません)。このフィールドでは DateTime 型の変数のみがサポートされています。DateTime の値は、MM/DD/YYYY の形式で指定する必要があります (例: 10/30/2019)。

出力

• イベント - [検索クエリ] の値に一致するイベントの配列 (Event オブジェクト) です。このフィールドは、Event[] 型変数のみをサポートします。後続のアクティビティで出力データを使用する予定がある場合は必須です。このプロパティ用に作成した変数は、他のアクティビティ ([イベント/予定を変更]、[場所を追加] など) の入力変数として使用できます。この変数を入力プロパティの値として使用する場合、必ず配列内の使用する項目を指定してください (例: myEvents(0))。 Event オブジェクトには、他のアクティビティで使用できる複数のプロパティが含まれています。すべてのプロパティがサポートされているわけではありません。Body.Content プロパティは、HTML 形式のみで返されます。

動作のしくみ

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

1. 手順を完了します。
2. プロジェクトに [Microsoft Office 365 スコープ] アクティビティを追加します。
3. (任意) Calendar オブジェクトを出力するアクティビティを追加するか外部プロセスを実行します (例: [予定表を取得])。
4. [Microsoft Office 365 スコープ] アクティビティ内に [イベントを検索] アクティビティを追加します。
5. [入力] セクションのプロパティに値を入力します。
6. [出力] セクションのプロパティのために Event[] 型変数を作成し、入力します。

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

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