isSoftphonePanelVisible() for Lightning Experience

Usage

Use this method to return the visibility status of the softphone panel. Returns true if the softphone panel is visible and false if it’s minimized. This method is available in API version 38.0 or later.

Syntax

1sforce.opencti.isSoftphonePanelVisible({
2     callback: FUNCTION
3});

Arguments

Name	Type	Description
`callback`	function	JavaScript method executed when the API method call is completed.

Sample Code–HTML and JavaScript with a callback

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 isSoftphonePanelVisible() {
14          sforce.opencti.isSoftphonePanelVisible({callback: callback});
15      }
16     </script>
17  </head>
18  <body>
19    <button onclick="isSoftphonePanelVisible();">isSoftphonePanelVisible()</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	Contains the boolean property `visible` which indicates the visibility status of the softphone panel. It’s `true` if the softphone is visible and `false` if it’s minimized.
`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.