Added in API level 31

TranslationResponseValue

class TranslationResponseValue : Parcelable
kotlin.Any
   ↳ android.view.translation.TranslationResponseValue

A translated response value from translation service.

Summary

Nested classes

A builder for TranslationResponseValue
Constants
static String

Name in the result of getExtras() to pass dictionary definitions of the text categorized by parts of speech.
static Int

This value was not successfully translated.
static Int

This value was successfully translated.
Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
static TranslationResponseValue

Creates a TranslationResponseValue with the STATUS_ERROR result;
Bundle

Extra results associated with the translated text.
Int

The status code of this TranslationResponseValue.
CharSequence?

The translated text result.
CharSequence?

The transliteration result of the translated text.
Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<TranslationResponseValue!>

Constants

EXTRA_DEFINITIONS

Added in API level 31
static val EXTRA_DEFINITIONS: String

Name in the result of 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. The individual parts of speech can be traversed by Bundle.keySet() and used to get the corresponding list of terms as CharSequences.

  • "noun" -> ["def1", "def2", ...]
  • "verb" -> ["def3", "def4", ...]
  • ...
The set of parts of speech can then be used by Bundle.getCharSequenceArrayList(String) to get the list of terms. Example: for (String partOfSpeech : extras.getBundle(EXTRA_DEFINITIONS).keySet()) { ArrayList<CharSequence> terms = extras.getBundle(EXTRA_DEFINITIONS).getCharSequenceArrayList(partOfSpeech); ... } 

Value: "android.view.translation.extra.DEFINITIONS"

STATUS_ERROR

Added in API level 31
static val STATUS_ERROR: Int

This value was not successfully translated. No value can be obtained with getText().

Value: 1

STATUS_SUCCESS

Added in API level 31
static val STATUS_SUCCESS: Int

This value was successfully translated.

Value: 0

Public methods

describeContents

Added in API level 31
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 31
fun equals(other: Any?): Boolean

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
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

forError

Added in API level 31
static fun forError(): TranslationResponseValue

Creates a TranslationResponseValue with the STATUS_ERROR result;

Return
TranslationResponseValue This value cannot be null.

getExtras

Added in API level 31
fun getExtras(): Bundle

Extra results associated with the translated text.

The bundle includes EXTRA_DEFINITIONS, obtained by Bundle.getBundle.

Return
Bundle This value cannot be null.

getStatusCode

Added in API level 31
fun getStatusCode(): Int

The status code of this TranslationResponseValue.

If the status code is STATUS_ERROR, no values are attached, and all getters will return null.

Return
Int Value is android.view.translation.TranslationResponseValue#STATUS_SUCCESS, or android.view.translation.TranslationResponseValue#STATUS_ERROR

getText

Added in API level 31
fun getText(): CharSequence?

The translated text result.

Return
CharSequence? This value may be null.

getTransliteration

Added in API level 31
fun getTransliteration(): CharSequence?

The transliteration result of the translated text.

This returns a CharSequence representation of the transliteration of the translated text.

Return
CharSequence? This value may be null.

hashCode

Added in API level 31
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 31
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 31
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 31
static val CREATOR: Parcelable.Creator<TranslationResponseValue!>