Home
JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
Domino®
This library provides access to the IBM® Domino® back-end.
NotesAgent (JavaScript™)
Represents an agent.
Target (NotesAgent - JavaScript™)
Read-only. Indicates on which documents this agent acts.

JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
- JavaScript™ language elements (JavaScript)
  The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
- Simple actions (JavaScript)
  A simple action performs a pre-programmed activity that can be modified by arguments.
- Global objects and functions (JavaScript™)
  Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
- DOM (JavaScript)
  Represents a document in XML Document Object Model format.
- Domino®
  This library provides access to the IBM® Domino® back-end.
  - NotesACL (JavaScript™)
    Represents the access control list (ACL) of a database.
  - NotesACLEntry (JavaScript™)
    Represents a single entry in an access control list. An entry may be for a person, a group, or a server.
  - NotesAdministrationProcess (JavaScript™)
    Represents the administration process. Note This class is new with Release 6.5.
  - NotesAgent (JavaScript™)
    Represents an agent.
    - Comment (NotesAgent - JavaScript™)
      Read-only. The comment that describes an agent, as entered by the agent's designer.
    - CommonOwner (NotesAgent - JavaScript™)
      Read-only. The common name of the person who last modified and saved an agent.
    - HttpURL (NotesAgent - JavaScript™)
      Read-only. The Domino® URL of an agent when HTTP protocols are in effect.
    - IsActivatable (NotesAgent - JavaScript™)
      Read-only. Indicates whether user activation is in effect when enabling or disabling a scheduled agent.
    - IsEnabled (NotesAgent - JavaScript™)
      Read-Write. Indicates whether an agent is able to run.
    - IsNotesAgent (NotesAgent - JavaScript™)
      Read-only. Indicates whether an agent can run in the Notes® client environment.
    - IsPublic (NotesAgent - JavaScript™)
      Read-only. Indicates whether an agent is shared or private.
    - IsWebAgent (NotesAgent - JavaScript™)
      Read-only. Indicates whether an agent can run in a Web browser environment.
    - LastRun (NotesAgent - JavaScript™)
      Read-only. The date that an agent last ran.
    - LockHolders (NotesAgent - JavaScript™)
      Read-only. The names of the holders of a lock.
    - Name (NotesAgent - JavaScript™)
      Read-only. The name of an agent. Within a database, the name of an agent may not be unique.
    - NotesURL (NotesAgent - JavaScript™)
      Read-only. The Domino® URL of an agent when Notes® protocols are in effect.
    - OnBehalfOf (NotesAgent - JavaScript™)
      Read-only. Name of the user under whose identity the agent runs.
    - Owner (NotesAgent - JavaScript™)
      Read-only. The name of the person who last modified and saved an agent.
    - ParameterDocID (NotesAgent - JavaScript™)
      Read-only. Returns the note ID of a document passed in by run or runOnServer.
    - Parent (NotesAgent - JavaScript™)
      Read-only. The database that contains an agent.
    - Query (NotesAgent - JavaScript™)
      Read-only. The text of the query used by an agent to select documents.
    - ServerName (NotesAgent - JavaScript™)
      Read-Write. The name of the server on which an agent runs.
    - Target (NotesAgent - JavaScript™)
      Read-only. Indicates on which documents this agent acts.
    - Trigger (NotesAgent - JavaScript™)
      Read-only. Indicates when this agent runs.
    - lock (NotesAgent - JavaScript™)
      Locks an agent.
    - lockProvisional (NotesAgent - JavaScript™)
      Locks an agent provisionally.
    - remove (NotesAgent - JavaScript™)
      Permanently deletes an agent from a database.
    - run (NotesAgent - JavaScript™)
      Runs the agent.
    - runOnServer (NotesAgent - JavaScript™)
      Runs the agent on the computer containing the database.
    - save (NotesAgent - JavaScript™)
      Saves changes made to the agent.
    - unlock (NotesAgent - JavaScript™)
      Unlocks an agent.
  - NotesAgentContext (JavaScript™)
    Represents the agent environment of the current program, if an agent is running it.
  - NotesBase (JavaScript™)
    Defines methods that are common to all the classes.
  - NotesCalendar (JavaScript™)
    Represents a Domino® calendar.
  - NotesCalendarEntry (JavaScript™)
    Represents a Domino® calendar entry.
  - NotesCalendarNotice (JavaScript™)
    Represents a Domino® calendar notice.
  - NotesColorObject (JavaScript™)
    Represents a color.
  - NotesDatabase (JavaScript™)
    Represents a Notes® database.
  - NotesDateRange (JavaScript™)
    Represents a range of dates and times.
  - NotesDateTime (JavaScript™)
    Represents a date and time.
  - NotesDbDirectory (JavaScript™)
    Represents the Domino® databases on a server or the local computer.
  - NotesDirectory (JavaScript™)
    Represents the Notes® directories on a specific server or local computer, each of which is associated with one or more directory navigators to allow directory lookups.
  - NotesDirectoryNavigator (JavaScript™)
    Allows lookups of a specific associated Notes® directory on a specific server or local computer.
  - NotesDocument (JavaScript™)
    Represents a document in a database.
  - NotesDocumentCollection (JavaScript™)
    Represents a collection of documents from a database.
  - NotesDxlExporter (JavaScript™)
    Represents the conversion of Domino® data to DXL (Domino XML). Note This class is new with Release 6.5.
  - NotesDxlImporter (JavaScript™)
    Represents the conversion of DXL (Domino® XML) to Domino data. Note This class is new with Release 6.5.
  - NotesEmbeddedObject (JavaScript™)
    Represents any one of the following: An embedded object An object link A file attachment Note Embedded objects and object links are not supported for OS/2, UNIX™, and the Macintosh. File attachments are supported.
  - NotesForm (JavaScript™)
    Represents a form in a database.
  - NotesIDVault (JavaScript™)
    The NotesIDVault class is a representation of the secure storage facility for UserIDs that may be configured for Domino by policy. IDs are stored there to allow for easier management by administrators and users. IDs from more than one server may be stored within an IDVault. The NotesIDVault class provides methods to access UserID files, UserID objects, query the presence of an ID in the vault, sycnronise copies of IDs, and reset passwords. The NotesIDVault class can be used to access UserID objects or files. These can be used to accomplish the encryption or decryption of Documents while running on the server.
  - NotesInternational (JavaScript™)
    Represents the international settings in the operating environment, for example, the Regional Settings in the Windows™ Control Panel. When settings change in the operating environment, Notes® recognizes the new settings immediately. For remote (IIOP) operations, these settings represent the session's server.
  - NotesItem (JavaScript™)
    Represents a discrete value or set of values in a document. The client interface displays items in a document through fields on a form. When a field on a form and an item in a document have the same name, the field displays the item (for example, the Subject field displays the Subject item). All items in a document are accessible programmatically, regardless of what form is used to display the document in the user interface.
  - NotesLog (JavaScript™)
    Enables you to record actions and errors that take place during a program's execution. You can record actions and errors in: A Domino® database A mail memo A file (for programs that run locally) An agent log (for agents)
  - NotesMIMEEntity (JavaScript™)
    Represents an item of type MIME (Multipurpose Internet Mail Extensions).
  - NotesMIMEHeader (JavaScript™)
    Represents a header in a MIME (Multipurpose Internet Mail Extensions) document.
  - NotesName (JavaScript™)
    Represents a user or server name.
  - NotesNewsletter (JavaScript™)
    Document or set of documents that contains information from, or links to, several other documents.
  - NotesNoteCollection (JavaScript™)
    Represents a collection of Domino® design and data elements in a database.
  - NotesOutline (JavaScript™)
    Represents an outline in a database.
  - NotesOutlineEntry (JavaScript™)
    Represents an entry in an outline.
  - NotesProperty (JavaScript™)
    Represents a single property in the Composite Applications properties of a Domino® application. Properties are data transmitted to or from the Property Broker, which routes your application's communication with other components in a composite application. Properties are defined in a Wiring Properties design element.
  - NotesPropertyBroker (JavaScript™)
    Mediates communication between components of a composite application, allowing communication between multiple Java™ components, or between Notes® and Java components.
  - NotesRegistration (JavaScript™)
    Represents the creation or administration of an ID file.
  - NotesReplication (JavaScript™)
    Represents the replication settings of a database.
  - NotesReplicationEntry (JavaScript™)
    Represents the replication settings for a pair of servers in a database.
  - NotesRichTextDoclink (JavaScript™)
    Represents a doclink in a rich text item.
  - NotesRichTextItem (JavaScript™)
    Represents an item of type rich text.
  - NotesRichTextNavigator (JavaScript™)
    Represents a means of navigation in a rich text item.
  - NotesRichTextParagraphStyle (JavaScript™)
    Represents rich text paragraph attributes.
  - NotesRichTextRange (JavaScript™)
    Represents a range of elements in a rich text item.
  - NotesRichTextSection (JavaScript™)
    Represents a collapsible section in a rich text item.
  - NotesRichTextStyle (JavaScript™)
    Represents rich-text attributes.
  - NotesRichTextTab (JavaScript™)
    Represents a tab in a rich text paragraph style.
  - NotesRichTextTable (JavaScript™)
    Represents a table in a rich text item.
  - NotesSession (JavaScript™)
    This class is the root of the Domino® Objects containment hierarchy, providing access to the other Domino objects, and represents the Domino server or Notes® client environment of the current program.
  - NotesStream (JavaScript™)
    Represents a stream of binary or character data. The stream can be associated with a file.
  - NotesUserID (JavaScript™)
    The NotesUserID class represents the Notes ID file or a Notes ID when it resides within the Domino IDVault. This object is primarily used to obtain the names of the private encryption keys which are available for use within the UserID object.
  - NotesView (JavaScript™)
    Represents a view or folder of a database and provides access to documents within it.
  - NotesViewColumn (JavaScript™)
    Represents a column in a view or folder.
  - NotesViewEntry (JavaScript™)
    Represents a view entry.
  - NotesViewEntryCollection (JavaScript™)
    Represents a collection of view entries of type document sorted in view order.
  - NotesViewNavigator (JavaScript™)
    Represents a view navigator. A view navigator provides access to all or a subset of the entries in a view.
  - NotesXSLTResultTarget (JavaScript™)
    Contains the result of a transformation by the XSL processor.
- Runtime (JavaScript)
  The Runtime library contains classes that provide useful methods for globalization.
- Standard (JavaScript)
  The Standard library contains classes for manipulating data of different types and performing common operations.
- XSP (JavaScript™)
  The XSP library contains classes that access the browser context.

Target (NotesAgent - JavaScript™)

Read-only. Indicates on which documents this agent acts.

Defined in

NotesAgent

Syntax

getTarget() : int

Legal value

0 TARGET_NONE Each incoming mail document, Newly received mail documents, or Pasted documents
1 TARGET_ALL_DOCS All documents in database
2 TARGET_NEW_DOCS Not used
3 TARGET_NEW_OR_MODIFIED_DOCS All new & modified documents
4 TARGET_SELECTED_DOCS All selected documents
5 TARGET_ALL_DOCS_IN_VIEW All documents in view
6 TARGET_UNREAD_DOCS_IN_VIEW All unread documents in view
8 TARGET_RUN_ONCE None
Note: Note This constant is new with Release 5.01.