PhoneProviders Class Reference

Inheritance diagram for PhoneProviders:

Collaboration diagram for PhoneProviders:

Static Public Member Functions
_.Library.Status	Create (_.Library.String Name, _.Library.String Properties)
	The following methods added to make the UI API consistent between SYS and EMS.
_.Library.Boolean	Exists (_.Library.String Name, _.Library.ObjectHandle PhoneProvider, _.Library.Status Status)
	PhoneProvider exists. More...
_.Library.Status	Export (_.Library.String FileName, _.Library.Integer NumExported, _.Library.String PhoneProviders)
	This method exports PhoneProvider records to a file in xml format. More...
_.Library.Status	GetProperties (_.Library.ObjectHandle PhoneProvider, _.Library.String Properties)
	Get a PhoneProvider's properties. More...
_.Library.Status	Import (_.Library.String FileName, _.Library.Integer NumImported, _.Library.Integer Flags)
	Import PhoneProvider records from an xml file. More...
_.Library.Status	Modify (_.Library.String Name, _.Library.String Properties)
	Modify a PhoneProvider. More...

Public Attributes
	Name
	Business name. More...
	SMSGateway
	DNS name of SMTP-to-SMS gateway. More...

Member Function Documentation

Exists()

_.Library.Boolean Exists ( _.Library.String  Name, _.Library.ObjectHandle  PhoneProvider, _.Library.Status  Status  )

static

PhoneProvider exists.

This method checks for the existence of a PhoneProvider in the security database.
Parameters:
Name - Name of the PhoneProvider to check existence of
Return values:
If Value of the method = 0 (PhoneProvider does not exist, or some error occured)
PhoneProvider = Null
Status = PhoneProvider "x" does not exist, or other error message<br>
If Value of the method = 1 (PhoneProvider exists)
PhoneProvider = Object handle to PhoneProvider
Status = $$$OK

Export()

_.Library.Status Export ( _.Library.String  FileName, _.Library.Integer  NumExported, _.Library.String  PhoneProviders  )

static

This method exports PhoneProvider records to a file in xml format.

Parameters:
Filename - Output file name
NumExported (byref) - Returns number of records exported.
PhoneProviders - Comma separated list of PhoneProviders to export, "*" = All

GetProperties()

_.Library.Status GetProperties ( _.Library.ObjectHandle  PhoneProvider, _.Library.String  Properties  )

static

Get a PhoneProvider's properties.

Gets a PhoneProviders's properties from the security database.
Parameters:
PhoneProvider - Object handle to a PhoneProviders record
Return values:
Properties - See the Get method for more information on properties returned

Import()

_.Library.Status Import ( _.Library.String  FileName, _.Library.Integer  NumImported, _.Library.Integer  Flags  )

static

Import PhoneProvider records from an xml file.

Parameters:
FileName - Filename to import PhoneProvider records from
NumImported (byref) - Returns number of records imported
Flags - Control import
Bit 0 - Do not import records, just return count
Note: On failure, no records will be imported

Modify()

_.Library.Status Modify ( _.Library.String  Name, _.Library.String  Properties  )

static

Modify a PhoneProvider.

Modify an existing PhoneProvider's properties in the security database.
Parameters:
Name - Name of the PhoneProvider to modify
Properties - Array of properties to modify.
See the Get() method for a description of the Properties parameter.
If a specific property is not passed in the properties array, the value is not modified.

Member Data Documentation

Name

Name

Business name.

 

SMSGateway

SMSGateway

DNS name of SMTP-to-SMS gateway.