@euirim/microsoft-cognitiveservices-speech-sdk
Version:
Microsoft Cognitive Services Speech SDK for JavaScript
72 lines (70 loc) • 2.71 kB
JavaScript
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
import { CancellationErrorCodePropertyName, EnumTranslation, SimpleSpeechPhrase } from "../common.speech/Exports";
import { CancellationErrorCode, CancellationReason } from "./Exports";
/**
* Contains detailed information about why a result was canceled.
* @class CancellationDetails
*/
export class CancellationDetails {
/**
* Creates and initializes an instance of this class.
* @constructor
* @param {CancellationReason} reason - The cancellation reason.
* @param {string} errorDetails - The error details, if provided.
*/
constructor(reason, errorDetails, errorCode) {
this.privReason = reason;
this.privErrorDetails = errorDetails;
this.privErrorCode = errorCode;
}
/**
* Creates an instance of CancellationDetails object for the canceled RecognitionResult.
* @member CancellationDetails.fromResult
* @function
* @public
* @param {RecognitionResult} result - The result that was canceled.
* @returns {CancellationDetails} The cancellation details object being created.
*/
static fromResult(result) {
let reason = CancellationReason.Error;
let errorCode = CancellationErrorCode.NoError;
if (!!result.json) {
const simpleSpeech = SimpleSpeechPhrase.fromJSON(result.json);
reason = EnumTranslation.implTranslateCancelResult(simpleSpeech.RecognitionStatus);
}
if (!!result.properties) {
errorCode = CancellationErrorCode[result.properties.getProperty(CancellationErrorCodePropertyName, CancellationErrorCode[CancellationErrorCode.NoError])];
}
return new CancellationDetails(reason, result.errorDetails, errorCode);
}
/**
* The reason the recognition was canceled.
* @member CancellationDetails.prototype.reason
* @function
* @public
* @returns {CancellationReason} Specifies the reason canceled.
*/
get reason() {
return this.privReason;
}
/**
* In case of an unsuccessful recognition, provides details of the occurred error.
* @member CancellationDetails.prototype.errorDetails
* @function
* @public
* @returns {string} A String that represents the error details.
*/
get errorDetails() {
return this.privErrorDetails;
}
/**
* The error code in case of an unsuccessful recognition.
* Added in version 1.1.0.
* @return An error code that represents the error reason.
*/
get ErrorCode() {
return this.privErrorCode;
}
}
//# sourceMappingURL=CancellationDetails.js.map