Salesforce Console Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
onSendCTIMessage()
Registers a function that is fired when a message is
sent with the sendCTIMessage(). Use to get information or send
information between an interaction log and a custom console component. This method is
only available in API version 31.0 or later.
Syntax
1sforce.console.cti.onSendCTIMessage( eventHandler:Function )Arguments
| Name | Type | Description |
|---|---|---|
| eventHandler | function | JavaScript method called when a message is sent with the onSendCTIMessage() method. |
Sample Code–Visualforce
1<apex:page>
2 <apex:includeScript value="/support/console/68.0/integration.js"/>
3 <script type="text/javascript">
4
5 var callback = function (result) {
6 alert('sendCTIMessage API sent the following message: ' + result.message);
7 };
8
9 sforce.console.cti.onSendCTIMessage(callback);
10
11 function sendCTIMessage() {
12 sforce.console.cti.sendCTIMessage('sending a message to CTI');
13 }
14 </script>
15 <a href="#" onClick="sendCTIMessage();return false">
16 Send a message to see your listener receiving it!</a>
17</apex:page>Response
This method is asynchronous, so it returns its response in an object in a callback method. The response object contains the following field:
| Name | Type | Description |
|---|---|---|
| message | string | The message that was sent with the onSendCTIMessage() method. |