この方法は、KPI 違反を示すために使用されます。 この API が呼び出されると、一意の識別子が渡されたセッションのアイコンに感嘆符が表示され、KPI 違反が発生したことを示します。
KPI 違反の表示をリセットするには、shouldReset パラメータの値を false に設定してこの API を呼び出します 。
構文
Microsoft.CIFramework.notifyKpiBreach(sessionId, shouldReset, details).then(successCallback, errorCallback);
Parameters
| Name | タイプ | 必須 | Description |
|---|---|---|---|
| sessionId | String | 可 | セッションの一意識別子です。 |
| shouldReset | ブール値 | いいえ | KPI 違反の表示をリセットするフラグ。 既定値は false です。 |
| details | String | いいえ | KPI 違反に関する詳細。 |
| successCallback | Function | いいえ | 要求が成功したときに呼び出す関数。 |
| errorCallback | Function | いいえ | 要求が失敗したときに呼び出す関数。 |
値を返す
None
例
Microsoft.CIFramework.notifyKpiBreach(sessionId, shouldReset, details).then(
function success(result) {
console.log(result);
// Perform operations
},
function (error) {
console.log(error.message);
// Handle error conditions
}
);