disableClickToDial() for Lightning Experience

Usage

Disables click-to-dial. This method is available in API version 38.0 or later.

You can use this method with the Lightning web component lightning-click-to-dial. You can also use it with the Aura component lightning:clickToDial. Keep in mind that you can’t use either component in iFrames. This method can’t be used with the Visualforce component support:clickToDial.

Note

Syntax

sforce.opencti.disableClickToDial({
     callback: function //Optional
})

Arguments

Name Type Description
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 disableClickToDial() {
          sforce.opencti.disableClickToDial({callback: callback});
      }
     </script>
  </head>
  <body>
    <button onclick="disableClickToDial();">disableClickToDial()</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.