FaxUser Object

The FaxUser object represents a single Facsys user.

Properties

Methods

Back to Top

ChangePassword Method

The ChangePassword method changes the Facsys password for the FaxUser object.

Syntax

ObjUser.ChangePassword (OldPassword, NewPassword)

Back to Top

Created Property

The Created property returns the date and time the FaxUser object was created. Read-only.

Syntax

ObjUser.Created

Data Type

Date

Back to Top

Department Property

The Department property returns or sets the department property of the FaxUser object.

Syntax

ObjUser.Department

Data Type

String

Back to Top

DisplayName Property

The DisplayName property returns or sets the display name of the FaxUser object. Read/write.

Syntax

ObjUser.DisplayName

Data Type

String

Back to Top

FaxNumber Property

The FaxNumber property returns or sets the fax number property of the FaxUser object.

Syntax

ObjUser.FaxNumber

Data Type

String

Back to Top

FirstName Property

The FirstName property returns or sets the FaxUser object's first name. Read/write.

Syntax

ObjUser.FirstName

Data Type

String

Back to Top

Flags Property

[undocumented in first release]

Back to Top

Index Property

The Index property returns the index of the user object within its parent FaxUsers collection. The index reflects this user’s position within the parent collection. Read-only.

Syntax

ObjUser.Index

Data Type

Long

Remarks

A user's index property may change if other user items are removed from the parent FaxUsers collection.

The first object in the collection has an Index value of 1.

Back to Top

LastName Property

The LastName property returns or sets the last name of the FaxUser object. Read/write.

Syntax

ObjUser.LastName

Data Type

String

Back to Top

ManagerID Property

The ManagerID property returns the unique 32-bit identifier that identifies the manager authorized to approve all FaxMessage objects sent by this FaxUser. Read/write.

Syntax

ObjUser.ManagerID

Data Type

Long

Back to Top

Modified Property

The Modified property returns the date and time when the FaxUser object was last modified. Read-only.

Syntax

ObjUser.Modified

Data Type

Date

Back to Top

PhoneNumber Property

The PhoneNumber property returns or sets the phone number property of the FaxUser object.

Syntax

ObjUser.PhoneNumber

Data Type

String

Back to Top

RouteId Property

The RouteId property returns or sets the route id property of the FaxUser object.

Syntax

ObjUser.RouteId

Data Type

String

Back to Top

SetDefaultCoverPage Method

The SetDefaultCoverPage method sets the default cover page file for the FaxUser.

Syntax

ObjUser.SetDefaultCoverPage (FaxCoverPage object)

Back to Top

Type Property

The Type property returns or sets the user type used to differentiate between a single user and a group user. Read-only.

Syntax

ObjUser.Type

Data Type

Long

Remarks

Valid values for this property are defined by the FaxMsg_UserType enumeration.

The Type property can be set at the time of creation of the user object by supplying the Type parameter to the Add method of the FaxUsers collection.

Back to Top

Update Method

The Update method updates or restores the properties of the FaxUser object.

Syntax

ObjUser.Update(Commit)

where the Commit parameter is a Boolean type that indicates whether the object properties should be committed (TRUE) or reset (FALSE). If TRUE, property updates are written to the server. If FALSE, property updates are overwritten with the original values.

Back to Top

UserID Property

The UserID property returns the unique 32-bit identifier that identifies this FaxUser. Read-only.

Syntax

ObjUser.UserID

Data Type

Long

Back to Top

UserName Property

The UserName property returns the User Name (alias) assigned to the FaxUser object. Read-only.

Syntax

ObjUser.UserName

Data Type

String

Back to Top