CancellationDetails Class

Package:

com.microsoft.cognitiveservices.speech

Maven Artifact:

com.microsoft.cognitiveservices.speech:client-sdk:1.38.0

• java.lang.Object
• • com.microsoft.cognitiveservices.speech.CancellationDetails

public class CancellationDetails

Contains detailed information about why a result was canceled.

Method Summary

Modifier and Type	Method and Description
void	close() Explicitly frees any external resource attached to the object
static CancellationDetails	fromResult(RecognitionResult result) Creates an instance of CancellationDetails object for the canceled RecognitionResult.
CancellationErrorCode	getErrorCode() The error code in case of an unsuccessful recognition (when getReason() returns Error).
java.lang.String	getErrorDetails() The error message in case of an unsuccessful recognition (when getReason() returns Error).
CancellationReason	getReason() The reason the recognition was canceled.
java.lang.String	toString() Returns a String that represents the cancellation details.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

close

public void close()

Explicitly frees any external resource attached to the object

fromResult

public static CancellationDetails fromResult(RecognitionResult result)

Creates an instance of CancellationDetails object for the canceled RecognitionResult.

Parameters:

result - The result that was canceled.

Returns:

The cancellation details object being created.

getErrorCode

public CancellationErrorCode getErrorCode()

The error code in case of an unsuccessful recognition (when getReason() returns Error). Added in version 1.1.0.

Returns:

An error code that represents the error reason.

getErrorDetails

public String getErrorDetails()

The error message in case of an unsuccessful recognition (when getReason() returns Error).

Returns:

A String that represents the error details.

getReason

public CancellationReason getReason()

The reason the recognition was canceled.

Returns:

Specifies the reason canceled.

toString

public String toString()

Returns a String that represents the cancellation details.

Overrides:

CancellationDetails.toString()

Returns:

A String that represents the cancellation details.