disableClickToDial() for Lightning Experience

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.

NameTypeDescription
callbackfunctionJavaScript method executed when the API method call is completed.

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

NameTypeDescription
successbooleanReturns true if the API method call was invoked successfully, false otherwise.
returnValueobjectThis API method doesn’t return this object. The returnValue is always null.
errorsarrayIf the API call was successful, this variable is null. If the API call failed, this variable returns an array of error messages.