Skip to main content


persistent class %SYS.PhoneProviders extends %Library.Persistent, %XML.Adaptor, %SYSTEM.Help

SQL Table Name: %SYS.PhoneProviders

Property Inventory

Method Inventory


property Name as %String [ Required ];
Business name
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property SMSGateway as %String [ Required ];
DNS name of SMTP-to-SMS gateway
Property methods: SMSGatewayDisplayToLogical(), SMSGatewayGet(), SMSGatewayGetStored(), SMSGatewayIsValid(), SMSGatewayLogicalToDisplay(), SMSGatewayLogicalToOdbc(), SMSGatewayNormalize(), SMSGatewaySet()


classmethod Create(Name As %String, ByRef Properties As %String) as %Status
The following methods added to make the UI API consistent between %SYS and EMS
classmethod Delete(Name As %String) as %Status
classmethod Exists(Name As %String, ByRef PhoneProvider As %ObjectHandle, ByRef Status As %Status) as %Boolean
PhoneProvider exists.
This method checks for the existence of a PhoneProvider in the security database.
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

If Value of the method = 1 (PhoneProvider exists)
PhoneProvider = Object handle to PhoneProvider
Status = $$$OK
classmethod Export(FileName As %String = "PhoneProvidersExport.xml", ByRef NumExported As %Integer, PhoneProviders As %String = "*") as %Status
This method exports PhoneProvider records to a file in xml format.
Filename - Output file name
NumExported (byref) - Returns number of records exported.
PhoneProviders - Comma separated list of PhoneProviders to export, "*" = All
classmethod Get(PhoneProvider As %String, ByRef Properties As %String) as %Status
classmethod GetProperties(PhoneProvider As %ObjectHandle, ByRef Properties As %String) as %Status
Get a PhoneProvider's properties.
Gets a PhoneProviders's properties from the security database.
PhoneProvider - Object handle to a PhoneProviders record
Return values:
Properties - See the Get method for more information on properties returned
classmethod Import(FileName As %String = "PhoneProvidersExport.xml", ByRef NumImported As %Integer, Flags As %Integer = 0) as %Status
Import PhoneProvider records from an xml file.
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
classmethod Modify(Name As %String, ByRef Properties As %String) as %Status
Modify a PhoneProvider.
Modify an existing PhoneProvider's properties in the security database.
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.


query List()
Selects Name As %String, SMSGateway As %String
SQL Query:
SELECT Name,SMSGateway FROM PhoneProviders ORDER BY Name


index (NameIndex on Name) [IdKey, Type = key];
Index methods: NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (%SYS.PhoneProviders)

FeedbackOpens in a new tab