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
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
no plans to implement
- Type
- Error
(inner) name() → {TextOrTextList}
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
- For further information, see www.hcltechsw.com
- Type:
- TextOrTextList
(inner) optimizeMailAddress()
Returns a mail address with all unnecessary domains removed.
- Source
no plans to implement
- Type
- Error
(inner) password()
Encodes a string.
- Source
- To Do
- this needs to be implemented
method not implemented
- Type
- Error
(inner) platform()
Returns the name of the currently running platform version of Notes, Domino, or Nomad.
- Source
- To Do
- this needs to be implemented
method not implemented
- Type
- Error
(inner) statusBar()
Writes a message or messages to the status bar.
- Source
- To Do
- this needs to be implemented
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
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.
| Name | Type | Attributes | Description |
|---|---|---|---|
index | string | <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
Promise that resolves to the current user name.
(inner) userNameLanguage()
Returns language tags associated with the user ID.
- Source
no plans to implement
- Type
- Error
(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
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
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
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
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
no plans to implement
- Type
- Error
(inner) version()
Returns the release number of the Notes/Domino software you're running.
- Source
no plans to implement
- Type
- Error