API Version: Development

Reference

/

Classes

/

IPCortex.Types.Phone

   
  • IPCortex.Types.Phone
  • Properties
  • Methods
  • phone.addListener
  • phone.removeListener
  • Events

    • IPCortex.Types.Phone

    Details about a single handset.
    A Device is a subset of a Phone and represents a callable line/identity. A Phone is made up of at least one Device, and depending on the physical device configuration may be as many as 12 lines.
    This Phone class is mostly used as a container, and has no operational purpose beyond providing information.

    Properties

    Name Type Description
    name String Name (basis for the SIP login).
    owner Contact Owners contact instance or null if unowned.
    ownerID Number Owners contact ID or null if unowned.
    lines Number The number of devices/lines/identities.
    devices Array A list of accociated Device instances.
    deviceNames Array A list of accociated device names (Strings). e.g. SIP/abc, SIP/abc_2
    extensions Array A list of Extension instaces that call this phone.
    mac String The unique identifier for this phone, based on the MAC address. All child devices will have the same identifier.
    features String Comma separated list of features.
    • hold
    • talk
    • answer

    Methods

    phone.addListener(event, callback)

    Kind: class method of IPCortex.Types.Phone
    Add listener method, inherited from Api base class and common to all classes.
    Parameter Type Description
    event String Name of event, e.g. 'update'
    callback Function Callback which is passed a reference to the updated Class object

    phone.removeListener(event, callback)

    Kind: class method of IPCortex.Types.Phone
    Remove listener method, inherited from Api base class and common to all classes. event and callback must be identical to those used in addListener() in order for the remove to succeed.
    Parameter Type Description
    event String Name of event, e.g. 'update'
    callback Function Callback which is passed a reference to the updated Class object

    Events

    • new - A new phone is created.