キュー アイテムを待機

指定されたキューから Orchestorator のキュー アイテムを取得し、QueueItem 型変数に格納します。このメソッドは、[トランザクション アイテムを取得] メソッドとは異なり、実行時に、指定したキューが空になっている場合、キュー受け入れ準備完了のメッセージを Orchestrator に送信し、指定したキューに新しいキュー アイテムが追加されるのを待ちます。アイテムを取得すると、そのキュー アイテムのステータスは [進行中] に設定されます。

定義

名前空間: UiPath.Activities.System.API

アセンブリ： UiPath.System.Activities.Api (UiPath のUiPath.System.Activities.Api.dll)

オーバー ロード

WaitQueueItem(String)	キュー内のアイテムが利用可能になるまで待機して処理し (トランザクションを開始し)、そのステータスを 進行中に設定します。
WaitQueueItem(String, String)	指定したフォルダー パスのキュー内のアイテムが利用可能になるまで待機し (トランザクションを開始し)、そのステータスを 進行中に設定します。
WaitQueueItem(String, String, Int32, ReferenceFilterStrategy, String, Int32)	指定したフォルダー パスのキュー内のアイテムの処理 (トランザクションの開始) が可能になるまで待機し、そのステータスを進行中に設定します。キュー アイテムは、特定のフィルター方法に基づいて検索したり、参照で検索したりできます。

WaitQueueItem(String)

キュー内のアイテムが利用可能になるまで待機して処理し (トランザクションを開始し)、そのステータスを 進行中に設定します。

QueueItem WaitQueueItem(
    string queueName
)

queueName String : キュー アイテムの検索先のキューの名前です。

WaitQueueItem(String, String)

指定したフォルダー パスのキュー内のアイテムが利用可能になるまで待機し (トランザクションを開始し)、そのステータスを 進行中に設定します。

QueueItem WaitQueueItem(
    string queueName,
    string folderPath
)

queueName String : キュー アイテムの検索先のキューの名前です。

folderPath 文字列 : 指定されたキューがある フォルダーのパス で、ププロセスが実行されているフォルダーと異なる場合に使用されます。このフィールドは文字列値のみをサポートし、サブフォルダーを示す区切り文字として / が使用されます。たとえば、 "Finance/Accounts Payable"です。

WaitQueueItem(String, String, Int32, ReferenceFilterStrategy, String, Int32)

指定したフォルダー パスのキュー内のアイテムの処理 (トランザクションの開始) が可能になるまで待機し、そのステータスを進行中に設定します。キュー アイテムは、特定のフィルター方法に基づいて検索したり、参照で検索したりできます。

QueueItem WaitQueueItem(
    string queueName,
    string folderPath,
    int pollTimeMS,
    ReferenceFilterStrategy filterStrategy,
    string reference,
    int timeoutMS
)

queueName String : キュー アイテムの検索先のキューの名前です。

folderPath 文字列 : 指定されたキューがある フォルダーのパス で、ププロセスが実行されているフォルダーと異なる場合に使用されます。このフィールドは文字列値のみをサポートし、サブフォルダーを示す区切り文字として / が使用されます。たとえば、 "Finance/Accounts Payable"です。

pollTimeMS Int32 : 2 回の試行の間に新しい項目の取得を試行する時間 (ミリ秒単位) を指定します。既定値は 30000 ミリ秒 (30 秒) です。

filterStrategy ReferenceFilterStrategy : 参照に従ってフィルター処理するときに使用する戦略です。次のオプションが利用できます。

• StartWith - 参照が、reference フィールドに指定した値で開始される項目を検索します。
• Equals - 参照が、reference フィールドに示されている値と同じ項目を検索します。

reference string : 参照に従って項目をフィルター処理します。

timeoutMS Int32 : アクティビティの実行が完了するまで待機する時間をミリ秒単位で指定します。指定した時間が経過しても実行が完了しない場合には例外をスローします。既定値は 30000 ミリ秒 (30 秒) です。

戻り値

QueueItem

取得したトランザクション アイテムです。