此方法用于指示 KPI 违规。 调用此 API 时,传递唯一标识符的会话图标上会出现一个感叹号,指示发生了 KPI 违规。
要重置 KPI 违规指示,请调用此 API,参数值 shouldReset 设置为 false。
Syntax
Microsoft.CIFramework.notifyKpiBreach(sessionId, shouldReset, details).then(successCallback, errorCallback);
参数
| 名称 | 类型 | Required | 说明 |
|---|---|---|---|
| 会话 Id | String | 是的 | 会话的唯一标识符。 |
| 应该重置 | 布尔 | 否 | 用于重置 KPI 违规指示的标志。 默认值为 false。 |
| details | String | 否 | 有关 KPI 违规的详细信息。 |
| success回调 | 功能 | 否 | 请求成功时要调用的函数。 |
| errorCallback | 功能 | 否 | 请求失败时要调用的函数。 |
返回值
None
Example
Microsoft.CIFramework.notifyKpiBreach(sessionId, shouldReset, details).then(
function success(result) {
console.log(result);
// Perform operations
},
function (error) {
console.log(error.message);
// Handle error conditions
}
);