# TranslationResponseValue Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary:[Nested Classes](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#nestedclasses)\|[Constants](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#constants)\|[Inherited Constants](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#inhconstants)\|[Fields](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#lfields)\|[Methods](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#inhmethods) # TranslationResponseValue *** ** * ** *** [Kotlin](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue "View this page in Kotlin")\|Java ` public final class TranslationResponseValue ` ` extends `[Object](https://developer.android.com/reference/java/lang/Object)` `` implements `[Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |---|---------------------------------------------------| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) || | ↳ | android.view.translation.TranslationResponseValue |
*** ** * ** *** A translated response value from translation service. ## Summary | ### Nested classes || |----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` class` | [TranslationResponseValue.Builder](https://developer.android.com/reference/android/view/translation/TranslationResponseValue.Builder) A builder for[TranslationResponseValue](https://developer.android.com/reference/android/view/translation/TranslationResponseValue) | | ### Constants || |--------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | [EXTRA_DEFINITIONS](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#EXTRA_DEFINITIONS) Name in the result of[getExtras()](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getExtras())to pass dictionary definitions of the text categorized by parts of speech. | | `int` | [STATUS_ERROR](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#STATUS_ERROR) This value was not successfully translated. | | `int` | [STATUS_SUCCESS](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#STATUS_SUCCESS) This value was successfully translated. | | ### Inherited constants | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | | | ### Fields || |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | ` public static final `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[TranslationResponseValue](https://developer.android.com/reference/android/view/translation/TranslationResponseValue)`>` | [CREATOR](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#CREATOR)
| | ### Public methods || |---------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` int` | ` `[describeContents](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` boolean` | ` `[equals](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Indicates whether some other object is "equal to" this one. | | ` static `[TranslationResponseValue](https://developer.android.com/reference/android/view/translation/TranslationResponseValue) | ` `[forError](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#forError())`() ` Creates a[TranslationResponseValue](https://developer.android.com/reference/android/view/translation/TranslationResponseValue)with the[STATUS_ERROR](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#STATUS_ERROR)result; | | ` `[Bundle](https://developer.android.com/reference/android/os/Bundle) | ` `[getExtras](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getExtras())`() ` Extra results associated with the translated text. | | ` int` | ` `[getStatusCode](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getStatusCode())`() ` The status code of this[TranslationResponseValue](https://developer.android.com/reference/android/view/translation/TranslationResponseValue). | | ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[getText](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getText())`() ` The translated text result. | | ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[getTransliteration](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getTransliteration())`() ` The transliteration result of the translated text. | | ` int` | ` `[hashCode](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#hashCode())`() ` Returns a hash code value for the object. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#toString())`() ` Returns a string representation of the object. | | ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | | ### Inherited methods | |-----------------------|---| | From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | || | From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | || ## Constants ### EXTRA_DEFINITIONS Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final String EXTRA_DEFINITIONS ``` Name in the result of[getExtras()](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getExtras())to pass dictionary definitions of the text categorized by parts of speech. The dictionary definitions consists of groups of terms keyed by their corresponding parts of speech. This map-like structure is stored in a[Bundle](https://developer.android.com/reference/android/os/Bundle). The individual parts of speech can be traversed by[Bundle.keySet()](https://developer.android.com/reference/android/os/BaseBundle#keySet())and used to get the corresponding list of terms as[CharSequence](https://developer.android.com/reference/java/lang/CharSequence)s. - "noun" -\> \["def1", "def2", ...\] - "verb" -\> \["def3", "def4", ...\] - ... The set of parts of speech can then be used by[Bundle.getCharSequenceArrayList(String)](https://developer.android.com/reference/android/os/Bundle#getCharSequenceArrayList(java.lang.String))to get the list of terms.**Example** :`for (String partOfSpeech : extras.getBundle(EXTRA_DEFINITIONS).keySet()) { ArrayList terms = extras.getBundle(EXTRA_DEFINITIONS).getCharSequenceArrayList(partOfSpeech); ... }`


Constant Value: "android.view.translation.extra.DEFINITIONS" ### STATUS_ERROR Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int STATUS_ERROR ``` This value was not successfully translated. No value can be obtained with[getText()](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getText()).
Constant Value: 1 (0x00000001) ### STATUS_SUCCESS Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int STATUS_SUCCESS ``` This value was successfully translated.
Constant Value: 0 (0x00000000) ## Fields ### CREATOR Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final Creator CREATOR ```

## Public methods ### describeContents Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int describeContents () ``` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of[writeToParcel(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.
| Returns || |-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
| ### equals Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean equals (Object o) ``` Indicates whether some other object is "equal to" this one. The`equals`method implements an equivalence relation on non-null object references: - It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`. - It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`. - It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`. - It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified. - For any non-null reference value`x`,`x.equals(null)`should return`false`. An equivalence relation partitions the elements it operates on into*equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters || |-----|-------------------------------------------| | `o` | `Object`: This value may be`null`.
| | Returns || |-----------|-------------------------------------------------------------------------------| | `boolean` | `true`if this object is the same as the obj argument;`false`otherwise.
| ### forError Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static TranslationResponseValue forError () ``` Creates a[TranslationResponseValue](https://developer.android.com/reference/android/view/translation/TranslationResponseValue)with the[STATUS_ERROR](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#STATUS_ERROR)result;
| Returns || |-----------------------------------------------------------------------------------------------------------------------|------------------------------------| | [TranslationResponseValue](https://developer.android.com/reference/android/view/translation/TranslationResponseValue) | This value cannot be`null`.
| ### getExtras Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Bundle getExtras () ``` Extra results associated with the translated text. The bundle includes[EXTRA_DEFINITIONS](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#EXTRA_DEFINITIONS), obtained by[Bundle.getBundle](https://developer.android.com/reference/android/os/Bundle#getBundle(java.lang.String)).

| Returns || |---------------------------------------------------------------------|------------------------------------| | [Bundle](https://developer.android.com/reference/android/os/Bundle) | This value cannot be`null`.
| ### getStatusCode Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getStatusCode () ``` The status code of this[TranslationResponseValue](https://developer.android.com/reference/android/view/translation/TranslationResponseValue). If the status code is[STATUS_ERROR](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#STATUS_ERROR), no values are attached, and all getters will return`null`.
| Returns || |-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | Value is[STATUS_SUCCESS](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#STATUS_SUCCESS), or[STATUS_ERROR](https://developer.android.com/reference/android/view/translation/TranslationResponseValue#STATUS_ERROR)
| ### getText Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public CharSequence getText () ``` The translated text result.
| Returns || |--------------------------------------------------------------------------------|---------------------------------| | [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | This value may be`null`.
| ### getTransliteration Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public CharSequence getTransliteration () ``` The transliteration result of the translated text. This returns a CharSequence representation of the transliteration of the translated text.
| Returns || |--------------------------------------------------------------------------------|---------------------------------| | [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | This value may be`null`.
| ### hashCode Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int hashCode () ``` Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by[HashMap](https://developer.android.com/reference/java/util/HashMap). The general contract of`hashCode`is: - Whenever it is invoked on the same object more than once during an execution of a Java application, the`hashCode`method must consistently return the same integer, provided no information used in`equals`comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce the same integer result. - It is*not* required that if two objects are unequal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

| Returns || |-------|-------------------------------------------| | `int` | a hash code value for this object.
| ### toString Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String toString () ``` Returns a string representation of the object.
| Returns || |--------------------------------------------------------------------|-----------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object.
| ### writeToParcel Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void writeToParcel (Parcel dest, int flags) ``` Flatten this object in to a Parcel.
| Parameters || |---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `dest` | `Parcel`: This value cannot be`null`.
| | `flags` | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
|