setSoftphoneItemIcon() for Lightning Experience

Usage

Sets the icon for the softphone item in the utility bar. Returns true if the function is successfully executed, and false when there is a failure. This method is available in API version 38.0 or later.

The softphone icon in the utility bar.

Syntax

sforce.opencti.setSoftphoneItemIcon({
     key:KEY, 
     callback:FUNCTION  //Optional
});

Arguments

Sample Code–HTML and JavaScript

<html> 
<head>
    <script type="text/javascript" src="https://domain:port/support/api//lightning/opencti_min.js"></script>
    <script type="text/javascript">
      var callback = function(response) {
         if (response.success) {
            console.log('API method call executed successfully! returnValue:', response.returnValue);
         } else { 
            console.error('Something went wrong! Errors:', response.errors);
         }
      };

      function setSoftphoneItemIcon() {
          sforce.opencti.setSoftphoneItemIcon({key:"call", callback: callback});
      }
     </script>
  </head>
  <body>
    <button onclick="setSoftphoneItemIcon();">setSoftphoneItemIcon()</button>
  </body>
</html>

Response

This method is asynchronous. The response is returned in an object passed to a callback method. The response object contains the following fields.