3.6 AddressBook

Provides access to address book data.

3.6.1 Properties

The following table lists properties along with their access and descriptions.

Property

Access

Description

AddressBookEntries

R/O

AddressBookEntries collection. The collection of entries in this address book.

AddressBookRights

R/O

AddressBookRights collection. Describes the rights users have to this address book.

Application

R/O

Application. The Application object.

Default

R/O

Boolean. TRUE if this is the default address book.

FieldDefinitions

R/O

FieldDefinitions collection. Defines the user-defined and predefined fields that can appear in this address book.

Name

R/O

String. The name of this address book.

ObjType

R/O

Enum (AddressBookTypeConstants) The type of this address book.

Owner

R/O

Address. Returns the address of the owner of the address book.

--GroupWise 8 SP1 and later.

Parent

R/O

AddressBooks collection. The AddressBooks collection that owns this object.

ProviderID

R/O

String. A string identifying the address book’s provider. Typically a Globally Unique Identifier (GUID) converted to a hex string. An empty string ("") means the provider is unidentified.

Shared

R/O

Enum (SharedFolderConstants). Returns whether the address book is shared.

SortOrder

R/W

Enum (SortConstants). Specifies whether the AddressBookEntries collection returns entries in ascending or descending order. This property is not persistent. It can be set, but it will revert back to the default value set by the address book provider when the AddressBook object is refreshed or freed from memory.

Subtype

R/O

Enum (AddressBookSubtypeConstants). The subtype of this address book.

3.6.2 Methods

Delete()

Deletes this address book from the parent AddressBooks collection.

Refresh()

Forces this AddressBook object, and all objects and collections owned by this address book, to reread property values from the message database.

Rename(String Name)

Renames the address book to the new name.

3.6.3 Remarks

Creating a new personal address book will automatically add a new folder under the contacts folder by the same name. Similarly, deleting a personal address book will remove the corresponding user contacts folder. If the deleted personal address book was currently assigned to the main contact folder, the GroupWise system will chose another personal address book to replace it in the contacts folder.