ifmapi

Index

PhoneBar Class

Namespace: Ifm

Script Source:

<script src="https://ifmapi.github.io/hash/phonebar/1.0/phonebar.min.js"></script>

Syntax

Constructors

The PhoneBar object is a singleton.

There is no public constructor for this class. Get a reference to the current object using:

Ifm.PhoneBar.instance

Static Methods

• canRun : function()
  • return : Boolean

Static Properties

• instance : Ifm.PhoneBar

Constants

Events

• initialized : function(phonebar, e)
  • e : Object
    • config : Object
    • options : Object
• languagechanged : function(phonebar, e)
  • e : Object
    • language : String

Call notifications:

• alerting : function(phonebar, e)
  • e : Object
    • callId : Number
• answered : function(phonebar, e)
  • e : Object
    • callId : Number
• assignment : function(phonebar, e)
  • e : Call
• booked : function(phonebar, e)
  • e : Object
    • mediatype : Mediatypes
    • campaignName : String
• callfailure : function(phonebar, e)
  • e : Object
    • callId : Number
    • cause : Number
    • protocolTerminationCause : Number
• othercall : function(phonebar, e)
  • e : Object
• pause : function(phonebar, e)
  • e : Object
    • reasonId : Number
    • reasonText : String
• ready : function(phonebar, e)
  • e : Object
    • callId : Number
• readyfordetach : function(phonebar, e)
  • e : Object
    • callId : Number
• readyfortransfer : function(phonebar, e)
  • e : Object
    • callId : Number
• terminated : function(phonebar, e)
  • e : Object
    • callId : Number
    • postCallWork : Boolean

Recording notifications:

• recordingstarted : function(phonebar, e)
  • e : Object
    • callId : Number
    • fileName : String
• recordingmutechanged : function(phonebar, e)
  • e : Object
    • callId : Number
    • rxChannelMuted : Boolean
    • txChannelMuted : Boolean
• recordingstopped : function(phonebar, e)
  • e : Object
    • callId : Number
    • result : Number

State events:

• statechanged : function(phonebar, e)
  • e : Object
    • previousState : States
    • currentState : States
• statetimechanged : function(phonebar, e)
  • e : Object
    • stateTime : Date
    • startTimer : Boolean

Supervisor messages:

• supervisormessage : function(phonebar, e)
  • e : Object
    • severity : Number
    • message : String

Instance Methods

• calls : function(optional filter)
  • filter : Number OR (Boolean) function(call)
  • return : Call
• currentState : function()
  • return : States
• currentStateTime : function()
  • return : Date
• getAgentList : function(campaignName, mask, callback)
  • campaignName : String
  • mask : Number
  • callback : function(e)
• getAssignedCampaignList : function(callback)
  • callback : function(e)
• getCampaignList : function(callId, mediatype, mask, callback)
  • callId : Number
  • mediatype : Mediatypes
  • mask : Number
  • callback : function(e)
• getOutboundCampaignList : function(callback)
  • callback : function(e)
• getTransferCampaignList : function(callId, callback)
  • callId : Number
  • callback : function(e)
• getPauseReasons : function(callback)
  • callback : function(e)
• getQueueInfo : function(campaignName, callback)
  • campaignName : String
  • callback : function(e)
    • e : Object
      • calls : Number
      • avgTime : Number
      • maxTime : Number
      • campaigns : Array
        • name : String
        • avgTime : Number
        • maxTime : Number
• getTransferAgentList : function(campaignName, callback)
  • campaignName : String
  • callback : function(e)
• initialize : function(config, options)
  • config : Object
  • options : Object
• isLoggedIn : function()
  • return : Boolean
• language : (String) function (optional lang)
  • lang : String [“en”, “it”]
• login : function (firstName, lastName, password, extension, optional callback)
  • firstName : String
  • lastName : String
  • password : String
  • extension : String
  • optional callback : function(e)
• logout : function (optional callback)
  • optional callback : function(e)
• makeCall : function (phoneNumber, campaignName, callingNumber, optional callback) {
  • phoneNumber : String
  • campaignName : String
  • callingNumber : String
  • optional callback : function(e)

• panic : function ()

• pause : function (optional reasonId, optional callback)
  • optional reasonId : Number
  • optional callback : function(e)
• ready : function (optional callId, optional callback)
  • optional callId : Number
  • optional callback : function(e)
• transferCall : function (callId, campaignName, optional agentFirstName, optional agentLastName, optional mandatory, optional mode, optional callback)
  • callId : Number
  • campaignName : String
  • optional agentFirstName : String
  • optional agentLastName : String
  • optional mandatory : Boolean
  • optional mode : Number
  • optional callback : function(e)
• startRecording : function (callId, optional fileName, optional settings)
  • callId : Number
  • optional fileName : String
  • optional settings : Number
• stopRecording : function (callId)
  • callId : Number
• muteRecording : function (callId, muteRxChannel, muteTxChannel)
  • callId : Number
  • muteRxChannel : Boolean
  • muteTxChannel : Boolean
• tagRecording : function (callId, tag)
  • callId : Number
  • tag : String

Instance Properties

• agent : Object
  • firstName : String
  • lastName : String
  • password : String
  • extension : String

Remarks

Examples

Get a reference to the object:

var phonebar = Ifm.PhoneBar.instance;

Set an event handler for a specific event:

Ifm.PhoneBar.events.statechanged = function (phonebar, e) { ... };

See Also

• Call class
• Mediatypes enum
• States enum

Copyright © IFM Infomaster. All rights reserved.