setSoftphonePanelIcon() for Lightning Experience

Usage

Sets the icon for the softphone panel. 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 panel icon.

Screen shot of softphone in utility bar.

Syntax

1sforce.opencti.setSoftphonePanelIcon({
2     key:KEY, 
3     callback:FUNCTION  //Optional
4});

Arguments

Name	Type	Description
`key`	string	The key corresponding to the icon in the Lightning Design System you want to use for the softphone panel icon.
`callback`	function	JavaScript method executed when the API method call is completed.

Sample Code–HTML and JavaScript

1<html>
2  <head>
3    <script type="text/javascript" src="https://domain:port/support/api//lightning/opencti_min.js"></script>
4    <script type="text/javascript">
5      var callback = function(response) {
6         if (response.success) {
7            console.log('API method call executed successfully! returnValue:', response.returnValue);
8         } else { 
9            console.error('Something went wrong! Errors:', response.errors);
10         }
11      };
12
13      function setSoftphonePanelIcon() {
14          sforce.opencti.setSoftphonePanelIcon({key:"call", callback: callback});
15      }
16     </script>
17  </head>
18  <body>
19    <button onclick="setSoftphonePanelIcon();">setSoftphonePanelIcon()</button>
20  </body>
21</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.

Name	Type	Description
`success`	boolean	Returns `true` if the API method call was invoked successfully, `false` otherwise.
`returnValue`	object	This API method doesn’t return this object. The `returnValue` is always `null`.
`errors`	array	If the API call was successful, this variable is `null`. If the API call failed, this variable returns an array of error messages.