Open CTI Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
setSoftphonePanelVisibility() for Lightning Experience
Usage
Sets the visibility status of the softphone panel. When the visible parameter is passed as true, the softphone panel is displayed. When it’s set to false, the panel is minimized. This method is available in API version 38.0 or later.
Syntax
sforce.opencti.setSoftphonePanelVisibility({
visible:true,
callback:function //Optional
});Arguments
| Name | Type | Description |
|---|---|---|
| visible | boolean | To dock (display) the softphone panel, set the value to true. To minimize (hide) the softphone panel, set the value to false. |
| callback | function | JavaScript method executed when the API method call is completed. |
Sample Code–HTML and JavaScript
<html>
<head>
<script type="text/javascript" src="https://domain:port/support/api/63.0/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 setSoftphonePanelVisibility() {
sforce.opencti.setSoftphonePanelVisibility({visible: true, callback: callback});
}
</script>
</head>
<body>
<button onclick="setSoftphonePanelVisibility();">setSoftphonePanelVisibility()</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.
| 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. |