User Environment

Source

Methods

(inner) domain()

Returns the name of the current user's Domino® mail domain listed in the current location document of the Personal Address Book.

Source
To Do
  • this needs to be implemented
Throws:

method not implemented

Type
Error

(inner) mailDbName()

Returns the name of the Domino® server and the name of the current user's mail database.

Source

(inner) name()

Allows you to manipulate hierarchical names. You can abbreviate the canonical format of a name, expand an abbreviated name to its canonical format, identify particular components within the name, and reverse the order of the components so that you can categorize a view by hierarchical names.

Enables you to convert a name between the Domino® and LDAP formats.

Source
See
Returns:

Promise

(inner) optimizeMailAddress()

Returns a mail address with all unnecessary domains removed.

Source

(inner) password()

Encodes a string.

Source
To Do
  • this needs to be implemented
Throws:

method not implemented

Type
Error

(inner) platform(specopt) → {TextOrTextList}

Returns the name of the currently running platform version of Domino.

Parameters:
NameTypeAttributesDescription
spec<optional>

Value of "SPECIFIC" returns more detailed information; for example, the version number in addition to the name of the platform.

Source
Returns:

Without the parameter, returns the name of the platform. When you use the "SPECIFIC" keyword, platform returns an array. The array contains the following items:

  • PrimaryOSName - The detailed platform name.
  • PrimaryOSVersionNumber - The current version number of the primary operating system if avaliable. For the UNIX™ platform, platform("SPECIFIC") returns only the specific platform name, not the version number.
Type: 
TextOrTextList

(inner) statusBar()

Writes a message or messages to the status bar.

Source
To Do
  • this needs to be implemented
Throws:

method not implemented

Type
Error

(inner) userAccess()

Given a server and file name, indicates the current user's level of access to the database.

Source
To Do
  • this needs to be implemented
Throws:

method not implemented

Type
Error

(inner) userName(indexopt)

Returns the current user name.

If the user name is hierarchical, @UserName returns it in canonical format (including the CN, OU, O, and C identifiers). To return the name in abbreviated format (omitting those identifiers), use @V3UserName.

Parameters:
NameTypeAttributesDescription
indexstring<optional>

Number. Optional. Indicating the index of user names. 0 is for primary name and 1 is for the alternate name. If this parameter is omitted, @UserName returns the primary name.

Source
See
Returns:

Promise that resolves to the current user name.

(inner) userNameLanguage()

Returns language tags associated with the user ID.

Source

(inner) userNamesList()

For a database on a server or a local database with "Enforce a consistent Access Control List across all replicas" in effect, @UserNamesList returns a text list containing the following information for the current user:

  • Common name
  • All hierarchical names (fully distinguished) that include the user name; for example, CN=My Name/OU=My Org Unit/O=My Org, plus */OU=My Org Unit/O=My Org, */O=My Org, and *
  • Any roles associated with the user in the ACL
  • All groups to which the user belongs (only if the database is on a server)
Source
To Do
  • this needs to be implemented
Throws:

method not implemented

Type
Error

(inner) userPrivileges()

Returns a text list of the current user's privileges. This function returns only the position of the privilege in the privilege list, not the name of the privilege.

Source
To Do
  • this needs to be implemented
Throws:

method not implemented

Type
Error

(inner) userRoles()

For a database on a server or a local replicated database, returns a list of roles that the current user has. Roles are defined in a database's access control list.

Source
To Do
  • this needs to be implemented
Throws:

method not implemented

Type
Error

(inner) v3UserName()

Returns the current user name or server name. Using @V3UserName on a local database or in a private view in a server-based database returns the user's name.

If the user name is hierarchical, @V3UserName returns the name in abbreviated format (omitting the CN, OU, O, and C identifiers). To return the name in canonical format, use @UserName.

Source
See
Returns:

Promise that resolves to the current user name or server name.

(inner) v4UserAccess()

Given a server and file name, indicates the current user's level of access to the database.

Source

(inner) version()

Returns the release number of the Notes/Domino software you're running.

Source