UnprocessedDocuments (NotesAgentContext - JavaScript™)
Read-only. The documents in a database that the current agent considers to be "unprocessed." The type of agent determines which documents are considered unprocessed.
Defined in
NotesAgentContextSyntax
getUnprocessedDocuments() :
NotesDocumentCollection
Usage
This method is valid only for agents.What documents are returned?
The following table describes the documents that are returned by getUnprocessedDocuments. Document selection occurs once, before the agent runs.
Agent runs on: | UnprocessedDocuments returns documents that meet all of these requirements: |
---|---|
All documents in database | Meet the search criteria specified in Agent Properties box |
All new & modified documents |
|
All unread documents in view |
|
All documents in view |
|
All selected documents |
|
None | Is the current document only |
Before New Mail Arrives | None (does not return any documents; use DocumentContext in AgentContext instead) |
After New Mail Arrives |
|
Newly modified documents |
|
Pasted documents |
|
Using UpdateProcessedDoc
For agents that run on new and modified documents, you must use updateProcessedDoc in Session to mark each document as "processed," which ensures that a document gets processed by the agent only once (unless it's modified again). If you do not call this method for each document, the agent processes the same documents the next time it runs.
The updateProcessedDoc method marks a document as processed only for the particular agent from which it is called. Using updateProcessedDoc in one agent has no effect on the documents that another agent processes.
Language cross-reference
UnprocessedDocuments property in LotusScript® NotesDatabase classUnprocessedDocuments property in Java™ Database class
@All function in formula language