読み込み専用。 現在のエージェントかビューアクションが「未処理」と判断するデータベースの文書です。どの文書が未処理であるとみなされるかは、エージェントの種類によって決まります。
取得する場合: Set notesDocumentCollection = notesDatabase .UnprocessedDocuments
このメソッドはエージェントかビューアクションスクリプトにだけ有効です。また、このメソッドは、NotesSession の CurrentDatabase プロパティから取得された NotesDatabase オブジェクトだけで呼び出されることがあります。エージェントまたはビューアクションに含まれないスクリプトでは、このメソッドは文書が 1 つも入っていない NotesDocumentCollection を返します。CurrentDatabase プロパティから取得されていない NotesDatabase オブジェクトで呼び出されたときは、このメソッドはエラーとなります。
このプロパティを使用するには、データベースが開いている必要があります。
次の表は UnprocessedDocuments プロパティが返す文書を示します。エージェントを実行する前に文書が 1 回選択されます。
| エージェントの実行対象 |
UnprocessedDocuments によって返される文書が満たさなければならないすべての要件 |
|---|---|
| データベースのすべての文書 |
[エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| 作成または変更されたすべての文書 |
このエージェントが UpdateProcessedDoc で処理していないこと エージェントが最後に実行されてから新規作成または更新されていること [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| ビューのすべての未読文書 |
ビューにある未読文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| ビューのすべての文書 |
ビューにある文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| 選択されたすべての文書 または ビューアクション |
ビューで選択されている文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| なし |
現在の文書のみ |
| 新規メールを受信する前にトリガーします。 |
なし (文書を返しません。代わりに、NotesSession.DocumentContext を使用します) |
| 新規メールを受信した後にトリガーします。 |
エージェントの最終実行後にデータベースに送信されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| 新規に更新された文書 |
エージェントの最終実行後に更新されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| 追加された文書 |
エージェントの最終実行後にデータベースに追加されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
新規作成および変更された文書、新規に受信したメール文書、新規に追加された文書、新規に変更された文書で実行されるエージェントの場合、NotesSession の UpdateProcessedDoc メソッドを使用して、各文書を「処理済み」にします。「処理済み」にすると、再び変更、メール送信、追加をされないかぎり、エージェントはその文書を処理しません。このメソッドを文書ごとに呼び出さないと、エージェントは次回の実行時にも同じ文書を処理します。
UpdateProcessedDoc が処理済みのマークを付けるのは、このメソッドの呼び出し元の特定のエージェントが処理した文書だけです。あるエージェントで UpdateProcessedDoc を使用しても、他のエージェントが処理する文書には影響がありません。
その他のすべてのエージェントとビューアクションでは、UpdateProcessedDoc による影響はありません。
ビューアクションで使用されるとき、UnprocessedDocuments が返す文書は選択文書で実行されるエージェントと同じです。