Class VoiceProfilePhraseCancellationDetails
- java.lang.Object
-
- com.microsoft.cognitiveservices.speech.speaker.VoiceProfilePhraseCancellationDetails
-
public class VoiceProfilePhraseCancellationDetails extends Object
Contains detailed information about why voice profile activation phrase request was canceled.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VoiceProfilePhraseCancellationDetailsfromResult(VoiceProfilePhraseResult result)Creates an instance of VoiceProfilePhraseCancellationDetails object for the canceled VoiceProfilePhraseResult.CancellationErrorCodegetErrorCode()The error code in case of an unsuccessful activation phrase request (when getReason() returns Error).StringgetErrorDetails()The error message in case of an unsuccessful activation phrase request (when getReason() returns Error).CancellationReasongetReason()The reason the activation phrase request was canceled.StringtoString()Returns a String that represents the cancellation details.
-
-
-
Method Detail
-
fromResult
public static VoiceProfilePhraseCancellationDetails fromResult(VoiceProfilePhraseResult result)
Creates an instance of VoiceProfilePhraseCancellationDetails object for the canceled VoiceProfilePhraseResult.- Parameters:
result- The voice profile phrase result that was canceled.- Returns:
- The cancellation details object being created.
-
getReason
public CancellationReason getReason()
The reason the activation phrase request was canceled.- Returns:
- Specifies the reason canceled.
-
getErrorCode
public CancellationErrorCode getErrorCode()
The error code in case of an unsuccessful activation phrase request (when getReason() returns Error).- Returns:
- An error code that represents the error reason.
-
getErrorDetails
public String getErrorDetails()
The error message in case of an unsuccessful activation phrase request (when getReason() returns Error).- Returns:
- A String that represents the error details.
-
-