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.
getMaxCapacity()
Returns the maximum chat capacity for the current agent, as specified in the agent's
assigned agent configuration. Available in API version 29.0 or
later.
Syntax
1sforce.console.chat.getMaxCapacity(callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| callback | function | JavaScript method called upon completion of the method. |
Sample Code–Visualforce
1<apex:page>
2 <apex:includeScript value="/support/console/68.0/integration.js"/>
3 <a href="#" onClick="testGetMaxCapacity();return false;">Get Max Capacity</a>
4
5 <script type="text/javascript">
6 function testGetMaxCapacity() {
7 sforce.console.chat.getMaxCapacity(function(result) {
8 if (result.success) {
9 alert('max capacity '+result.count);
10 } else {
11 alert('getMaxCapacity failed, agent my not be online');
12 }
13 });
14 }
15 </script>
16</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 properties:
| Name | Type | Description |
|---|---|---|
| count | integer | Agent's current, maximum chat capacity. |
| success | boolean | true if getting the agent’s capacity was successful; false if getting the agent’s capacity wasn’t successful. |