Accessing session properties

The following table lists the NotesSession properties.

Property

Data type

Description

AddressBooks

NotesDatabase array

(Read-only) Accessible Public and Personal Address books, both local and remote

CommonUserName

String

(Read-only) Common name of the current server or user

ConvertMIME

Boolean

(Read-write) True if items of type MIME_PART are converted to rich text upon instantiation

CurrentAgent

NotesAgent

(Read-only) Agent in which the program is running

CurrentDatabase

NotesDatabase

(Read-only) Database in which the program is running

DocumentContext

DocumentContext

(Read-only) In-memory document created by an external program through the Notes® API

EffectiveUserName

String

(Read-only) User ID of the creator of the current script

HttpURL

String

(Read-only) The HTTP URL of a session.

International

NotesRichTextItem

(Read-only) The international (regional) settings for your operating environment

IsOnServer

Boolean

(Read-only) True if the program is running on a server

LastExitStatus

Integer

(Read-only) Status the last time the script ran, if an agent

LastRun

Date/Time

(Read-only) Date and time the script last ran, if an agent

NotesBuildVersion

String

(Read-only) Build version of Domino® Designer

NotesURL

String

(Read-only) The Notes® URL of a session. For COM only.

NotesVersion

String

(Read-only) Version of Domino® Designer

OrgDirectoryPath

String

(Read-only) Default directory of the current user in a hosted organization

Platform

String

(Read-only) Operating system platform

SavedData

NotesDocument

(Read-only) Document that stores data between agent invocations, if an agent

ServerName

String

(Read-only) The full name of the server. For COM only.

URLDatabase

NotesDatabase

(Read-only) Database object representing the default Web Navigator database.

UserGroupNameList

Array of NotesName

(Read-only) Returns the groups to which the current user belongs

UserName

String

(Read-only) User ID (hierarchical name) of the current server or user

UserNameList

Array of NotesName

(Read-only) Returns all the user names on a session, including primary and alternate names

UserNameObject

NotesName

(Read-only) The name of the user or server that created the session. For COM only.