NotesSession
Properties
| Name | Description |
|---|---|
| AddressBooks | Read-only. The Domino® Directories and Personal Address Books, including directory catalogs, known to the current session. |
| CommonUserName | Read-only. The common name portion of the current user's name. |
| ConvertMIME | Read-write. Indicates whether items of type MIME_PART are converted to rich text upon NotesDocument instantiation. |
| CurrentAgent | Read-only. The agent that's currently running. |
| CurrentDatabase (NotesSession) | Read-only. The database in which the current script resides. This database may or may not be open. |
| DocumentContext | Read-only. The in-memory document when an agent starts. |
| EffectiveUserName | Read-only. The user name that is in effect for the current program. |
| GetPropertyBroker | Retrieves the property broker for this session. |
| HttpURL (NotesSession) | Read-only. The Domino® URL of a session when HTTP protocols are in effect. |
| International | Read-only. The international (regional) settings for your operating environment. |
| IsOnServer | Read-only. Indicates whether a script is running on a server. |
| LastExitStatus | Read-only. The exit status code returned by the Agent Manager the last time the current agent ran. |
| LastRun (NotesSession) | Read-only. The date when the current agent was last executed. |
| NotesBuildVersion | Read-only. The Notes® build version in which a selected document resides. |
| NotesURL (NotesSession) | Read-only. The Domino® URL of a session when Notes® protocols are in effect. |
| NotesVersion | Read-only. The release of Notes® in which the current script is running. |
| OrgDirectoryPath | Read-only. The default directory of the current user in a hosted organization. |
| Platform | Read-only. The name of the platform on which the session is running. |
| SavedData | Read-only. A document that an agent script uses to store information in between invocations. The script can use the information in this document the next… |
| ServerName (NotesSession) | Read-only. The full name of the server that the session is running on. |
| URLDatabase | Read-only. A database object representing the default Web Navigator database. |
| UserGroupNameList | Read-only. The groups to which the current user belongs. |
| UserName | Read-only. The current user's name. |
| UserNameList | Read-only. The name of the user or server that created the session, and the alternate name if it exists. |
| UserNameObject | Read-only. The name, in the form of a NotesName object, of the user or server that created the session. |
Methods
| Name | Description |
|---|---|
| CreateAdministrationProcess | Creates a new NotesAdministrationProcess object. |
| CreateColorObject | Creates a new NotesColorObject object. |
| CreateDateRange | Creates a new NotesDateRange object. |
| CreateDateTime | Given a string that represents the date and time you want, creates a new NotesDateTime object that represents that date and time. When used with OLE… |
| CreateDOMParser | Creates a NotesDOMParser object. |
| CreateDXLExporter | Creates a NotesDXLExporter object. |
| CreateDXLImporter | Creates a NotesDXLImporter object. |
| CreateLog | Creates a new NotesLog object with the name you specify. When used with OLE automation, this method allows you to create a NotesLog object without using… |
| CreateName | Creates a new NotesName object. When used with OLE automation, this method allows you to create a NotesName object without using the New method of… |
| CreateNewsletter | Given a NotesDocumentCollection containing the documents you want, creates a new NotesNewsletter. When used with OLE automation, this method allows you… |
| CreateRegistration | Creates a new NotesRegistration object. |
| CreateRichTextParagraphStyle | Creates a new NotesRichTextParagraphStyle object. |
| CreateRichTextStyle | Creates a NotesRichTextStyle object. |
| CreateSAXParser | Creates a NotesSAXParser object. |
| CreateStream | Creates a NotesStream object. |
| CreateTimer | Creates a NotesTimer object. |
| CreateXSLTransformer | Creates a NotesXSLTransformer object. |
| Evaluate | Evaluates a Domino® formula. |
| FileOpBegin | Exports a file from the browser virtual file system to the host machine filesystem, or prepares a file system mapping for a new file. |
| FileOpEnd | Completes a file operation started by FileOpBegin. The host machine file is copied back into the browser virtual file system at the location specified in… |
| FreeResourceSearch | Searches for free resource slots for calendaring and scheduling. |
| FreeTimeSearch | Searches for free time slots for calendaring and scheduling. |
| GetCalendar | Creates a new NotesCalendar object. |
| GetDatabase | Creates a NotesDatabase object that represents the database located at the server and file name you specify, and opens the database, if possible. |
| GetDbDirectory | Creates a new NotesDbDirectory object using the name of the server you want to access. When used with OLE automation, this method allows you to create a… |
| GetDirectory | Creates a new NotesDirectory object using the name of the server you want to access. |
| GetEnvironmentString | Given the name of a string environment variable, retrieves its value. |
| GetEnvironmentValue | Given the name of a numeric environment variable, retrieves its value. |
| GetOIDCAccessToken | It is used to acquire an access token from a Domino OIDC Provider for the current user as identified and authenticated by their ID file. |
| GetUserPolicySettings | Gets a policy document. |
| HashPassword | Hashes a string value so that it is not recognizable. |
| Initialize | Initializes a COM session with the current user ID. |
| InitializeUsingNotesUserName | Initializes a COM session with a specified user name. |
| ResetUserPassword (NotesSession) | Use an agent to change the password of a user ID stored in the ID vault and/or specify the number of times a user ID can be downloaded from the vault… |
| Resolve | Returns the Domino® object that a URL addresses. |
| SendConsoleCommand | Sends a console command to a Domino® server. |
| SetEnvironmentVar | Sets the value of a string or numeric environment variable. |
| UpdateProcessedDoc | Marks a document as processed by an agent. |
| UseDoubleAsPointer | Allows you to use a Double to handle a 64-bit pointer argument for a C API call. |
| VerifyPassword | Verifies a plain string value against a hashed value. |
Examples
| Name | Description |
|---|---|
| Examples: CurrentDatabase property (NotesSession) | 1. This script gets the current database. For example, if this script runs in the database PROJECTS.NSF on server Damascus, then the db object represents… |
| Examples: DocumentContext property | 1. This agent displays the Subject item of the current document when run from a view in the Notes client. |
| Examples: EffectiveUserName property | This script gets the current effective user name. |
| Examples: GetCalendar method | This agent gets calendar and scheduling information for the current user for today and tomorrow. |
| Examples: IsOnServer property | This function takes a person's last name, looks the name up in the People view of an Address Book, and returns the person's office phone number as a… |
| Examples: LastExitStatus property | This agent script checks the last exit status of the current agent and prints a message in the status bar. |
| Examples: LastRun property (NotesSession) | 1. This agent script gets the date that the agent was last run, and puts it into runDate. For example, if the agent last ran on August 15, 1996, at… |
| Examples: NotesVersion property | This form action script gets the release of Notes® currently running and puts it in the variable version. For example, if the script runs on a… |
| Examples: OrgDirectoryPath property | This agent prepends the organization directory, if any, to a file name. |
| Examples: ServerName property (NotesSession) | This Visual Basic code displays the server name or an exception message if it is running on a client. |
| Examples: UserNameObject property | This Visual Basic code displays the current user's common name. |
Reference
| Name | Description |
|---|---|
| AdjustPointer | Starting with 14.5.0, there is a 64-bit API that increments or decrements pointer by specified offset. |