Facsys AFM/SDK Solgenia® Facsys™ Fax Messaging/Routing Gateway
Software Development Kit (SDK)
AFM & Web Services

Download
SDK


Contact

   
Introduction Object Model Tasks Samples & Languages Packaging Troubleshooting FAQ Appendices
   

FaxUsers Collection Object

The FaxUsers collection object can contain zero or more FaxUser objects.

Properties

Name

Data Type

Access

Class

Long

Read-only

Parent

FaxSession object

Read-only

Session

FaxSession object

Read-only

     

Count

Long

Read-only

Item

FaxUser object

Read-only

 

 

Methods

Name

Input Parameters

Return Values

Add

UserName as String, (Optional) Password as String, (Optional) DisplayName as String

FaxUser object

Remove

Index as Long

 

RemoveAll

(None)

 
 

Back to Top

 

Add Method

The Add method creates and returns a new FaxFolder object in the FaxFolders collection. The Add method also creates server based resources associated with the folder.

Syntax

ObjUsers.Add(UserName)

Remarks

Optional input parameters include the user's Password (string) and the user's DisplayName (string).

Back to Top

 

Count Property

The Count property returns the number of FaxUser objects contained in the collection. Read-only.

Syntax

ObjUsers.Count

Data Type

Long

Back to Top

 

Item Property

The Item property returns a single FaxUser object from the collection. Read-only.

Syntax

ObjUsers.Item(Index)

where Index is a long integer ranging from 1 to the size of the collection (i.e., value of Count property).

Data Type

FaxUser object

Remarks

The Item property is the default property of the FaxUsers collection object.

Use the Item property to reference a particular FaxUser object.

Back to Top

 

Remove Method

The Remove method deletes the FaxUser object with the specified index from the collection. Server based resources associated with the user are also deleted.

Syntax

ObjUsers.Remove(Index)

where Index is a long integer ranging from 1 to the size of the collection (i.e., value of Count property).

Remarks

Remove will fail with an invalid argument error if this user is the default administrator user account shipped with Facsys.

Back to Top

 

RemoveAll Method

The RemoveAll method deletes all FaxUser objects from the collection. Server-based resources associated with the users are also deleted.

Syntax

ObjUsers.RemoveAll

Remarks

The RemoveAll method will not delete the default administrator account shipped with Facsys. This operation is permanent - it cannot be undone.

Back to Top

Session

Image

Constant Definitions

Error Codes


Common Properties

Folders

Folder

Messages

Message

Recipients

Recipient

Attachments

Attachment

Phonebooks

Phonebook

Containers

Container

Entries

Entry

Fields

Field

Coverpages

Coverpage

Users

User

Home  |  Solgenia  |  Facsys  |  Facsys Support  |  Download Request  |  Contact