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 HCL Domino® back-end.
NotesRegistration (JavaScript™)
Represents the creation or administration of an ID file.
RoamingSubdir (NotesRegistration - JavaScript™)
Read-write. The subdirectory that contains the user's roaming data.

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 HCL 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.
  - 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 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.
    - AltOrgUnit (NotesRegistration - JavaScript™)
      Read-write. Alternate names for the organizational unit to use when creating ID files.
    - AltOrgUnitLang (NotesRegistration - JavaScript™)
      Read-write. Alternate names for the organizational unit to use when creating ID files.
    - CertifierIDFile (NotesRegistration - JavaScript™)
      Read-Write. The complete file specification of the certifier ID to use when creating IDs.
    - CertifierName (NotesRegistration - JavaScript™)
      Read-write. The certifier when a Notes® ID is not being used.
    - CreateMailDb (NotesRegistration - JavaScript™)
      Read-Write. Indicates whether a mail database is created with the ID file when calling registerNewUser.
    - Expiration (NotesRegistration - JavaScript™)
      Read-Write. The expiration date to use when creating ID files.
    - GroupList (NotesRegistration - JavaScript™)
      Read-write. The groups to which a user is assigned during registration.
    - IDType (NotesRegistration - JavaScript™)
      Read-Write. The type of ID file to create.
    - IsEnforceUniqueShortName (NotesRegistration - JavaScript™)
      Read-write. Indicates whether a short name must be unique.
    - IsMailCreateFTIndex (NotesRegistration - JavaScript™)
      Read-write. Indicates the creation of a full-text index for the mail database.
    - IsNoIDFile (NotesRegistration - JavaScript™)
      Read-write. Indicates that no ID file is created during registration.
    - IsNorthAmerican (NotesRegistration - JavaScript™)
      Read-Write. Indicates whether an ID file is North American.
    - IsRoamingUser (NotesRegistration - JavaScript™)
      Read-write. Indicates whether a user is a roaming user.
    - IsStoreIDInMailfile (NotesRegistration - JavaScript™)
      Read-write. Indicates whether the ID file is stored in the user's mail file.
    - IsSynchInternetPassword (NotesRegistration - JavaScript™)
      Read-write. Synchronizes the user's Internet password with the password for the Notes® client ID.
    - IsUseCertificateAuthority (NotesRegistration - JavaScript™)
      Read-write. Indicates that the certificate authority (CA) is used for registration.
    - MailACLManager (NotesRegistration - JavaScript™)
      Read-write. A name that is assigned Manager access in the mail database ACL.
    - MailInternetAddress (NotesRegistration - JavaScript™)
      Read-write. The user's Internet name for sending and receiving mail.
    - MailOwnerAccess (NotesRegistration - JavaScript™)
      Read-write. The mail database ACL setting for the owner.
    - MailQuotaSizeLimit (NotesRegistration - JavaScript™)
      Read-write. The maximum size of the user's mail database, in megabytes.
    - MailQuotaWarningThreshold (NotesRegistration - JavaScript™)
      Read-write. The size, in megabytes, at which the user's mail database issues a warning that it is getting too large.
    - MailReplicaServers (NotesRegistration - JavaScript™)
      Read-write. The names of servers to which the mail database will replicate.
    - MailSystem (NotesRegistration - JavaScript™)
      Read-write. The user's mail system.
    - MailTemplateName (NotesRegistration - JavaScript™)
      Read-write. The name of the template for the design of the mail file.
    - MinPasswordLength (NotesRegistration - JavaScript™)
      Read-Write. The strength assigned to a password in an ID file. Note The assignment of strength instead of length in the property is new with Release 5.
    - OrgUnit (NotesRegistration - JavaScript™)
      Read-Write. The organizational unit to use when creating ID files.
    - Parent (NotesRegistration - JavaScript™)
      Read-only. The session that contains a Registration object.
    - PolicyName (NotesRegistration - JavaScript™)
      Read-write. The name of an explicit policy.
    - RegistrationLog (NotesRegistration - JavaScript™)
      Read-Write. The log file to use when creating IDs.
    - RegistrationServer (NotesRegistration - JavaScript™)
      Read-Write. The server to use when creating IDs and performing other registration functions.
    - RoamingCleanupPeriod (NotesRegistration - JavaScript™)
      Read-write. The interval in days for cleaning up data on Notes® clients set up for roaming users.
    - RoamingCleanupSetting (NotesRegistration - JavaScript™)
      Read-write. Indicates the clean-up process for data on Notes® clients set up for roaming users.
    - RoamingServer (NotesRegistration - JavaScript™)
      Read-write. The server on which the user's roaming data is stored.
    - RoamingSubdir (NotesRegistration - JavaScript™)
      Read-write. The subdirectory that contains the user's roaming data.
    - ShortName (NotesRegistration - JavaScript™)
      Read-write. The short name when creating user IDs.
    - StoreIDInAddressBook (NotesRegistration - JavaScript™)
      Read-Write. Indicates whether the ID file is stored in the server's Domino® Directory.
    - UpdateAddressBook (NotesRegistration - JavaScript™)
      Read-Write. Indicates whether an ID document in the Domino® Directory is created when the ID file is created.
    - addCertifierToAddressBook (NotesRegistration - JavaScript™)
      Creates a Certifier record in a Domino® Directory based on a certifier ID file and optionally attaches the ID file.
    - addServerToAddressBook (NotesRegistration - JavaScript™)
      Creates a Server record in a Domino® Directory based on a server ID file and optionally attaches the ID file.
    - addUserProfile (NotesRegistration - JavaScript™)
      Adds the name of a setup profile to the user's Person record in the Domino® Directory.
    - addUserToAddressBook (NotesRegistration - JavaScript™)
      Creates a Person record in a Domino® Directory based on a user ID file and optionally attaches the ID file.
    - crossCertify (NotesRegistration - JavaScript™)
      Cross-certifies an ID file.
    - deleteIDOnServer (NotesRegistration - JavaScript™)
      Deletes the user ID attachment from a Person or Server record in a Domino® Directory.
    - getIDFromServer (NotesRegistration - JavaScript™)
      Detaches the user ID file from a Person or Server record in a Domino® Directory.
    - getUserInfo (NotesRegistration - JavaScript™)
      Gets information about a user from a Domino® Directory.
    - recertify (NotesRegistration - JavaScript™)
      Recertifies an ID file.
    - registerNewCertifier (NotesRegistration - JavaScript™)
      Creates a certifier ID and optionally adds it to a Domino® Directory.
    - registerNewServer (NotesRegistration - JavaScript™)
      Creates a server ID and optionally adds it to a Domino® Directory.
    - registerNewUser (NotesRegistration - JavaScript™)
      Creates a user ID and optionally adds it to a Domino® Directory.
    - switchToID (NotesRegistration - JavaScript™)
      Switches to a different 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.

RoamingSubdir (NotesRegistration - JavaScript™)

Read-write. The subdirectory that contains the user's roaming data.

Defined in

NotesRegistration

Syntax

getRoamingSubdir() : string

setRoamingSubdir(server:string) : void

Usage

Optionally set this property before calling registerNewUser.

IsRoamingUser must be true.