setServicePresenceStatus
エージェントのプレゼンス状況を特定の ID を持つ状況に設定します。API バージョン 35.0 以降では、まだログインしていないユーザはプレゼンスにログインされるため、追加のコールを実行する必要はありません。接続エラーの後にこのメソッドを使用して、オムニチャネルに再接続することもできます。
構文
1sforce.console.presence.setServicePresenceStatus(statusId:String,
2 (optional) callback:function)引数
| 名前 | 型 | 説明 |
|---|---|---|
| statusId | String | エージェントに設定するプレゼンス状況の ID。関連するプロファイルまたは権限セットを使用して、このプレゼンス状況へのアクセス権をエージェントに付与する必要があります。 |
| callback | function | statusId に関連付けられたプレゼンス状況にエージェントの状況を変更したときにコールする JavaScript メソッド。 |
サンプルコード – Visualforce
1<apex:page>
2 <apex:includeScript value="/support/console/52.0/integration.js"/>
3 <a href="#" onClick="testSetStatus('0N5xx00000000081');return false;">Set Presence Status</a>
4
5 <script type="text/javascript">
6 function testSetStatus(statusId) {
7
8 //Sets the user’s presence status to statusID. Assumes that the user was assigned this presence status through Setup.
9 //These values are for example purposes only
10 sforce.console.presence.setServicePresenceStatus(statusId, function(result) {
11 if (result.success) {
12 alert('Set status successful');
13 alert('Current statusId is: ' + result.statusId);
14 alert('Channel list attached to this status is: ' + result.channels); //printout in console for lists
15 } else {
16 alert('Set status failed');
17 }
18 });
19 }
20 </script>
21</apex:page>応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次のプロパティが含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| success | Boolean | エージェントの状況が正常に設定された場合は true、エージェントの状況が正常に設定されなかった場合は false。 |
| statusName | String | エージェントの現在のプレゼンス状況の名前。 |
| statusApiName | String | エージェントの現在のプレゼンス状況の API 名。 |
| statusId | String | エージェントの現在のプレゼンス状況の ID。 |
| channels | channel オブジェクトの JSON 文字列 | プレゼンス状況に関連付けられたチャネルの ID と API 参照名を返します。 |