TranslationResponseValue
class TranslationResponseValue : Parcelable
| kotlin.Any | |
| ↳ | android.view.translation.TranslationResponseValue |
A translated response value from translation service.
Summary
| Nested classes | |
|---|---|
|
A builder for |
|
| Constants | |
|---|---|
| static String |
Name in the result of |
| static Int |
This value was not successfully translated. |
| static Int |
This value was successfully translated. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| static TranslationResponseValue |
forError()Creates a |
| Bundle |
Extra results associated with the translated text. |
| Int |
The status code of this |
| CharSequence? |
getText()The translated text result. |
| CharSequence? |
The transliteration result of the translated text. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<TranslationResponseValue!> | |
Constants
EXTRA_DEFINITIONS
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", ...]
- ...
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
static val STATUS_ERROR: Int
This value was not successfully translated. No value can be obtained with getText().
Value: 1STATUS_SUCCESS
static val STATUS_SUCCESS: Int
This value was successfully translated.
Value: 0Public methods
describeContents
fun describeContents(): Int
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), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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
static fun forError(): TranslationResponseValue
Creates a TranslationResponseValue with the STATUS_ERROR result;
| Return | |
|---|---|
TranslationResponseValue |
This value cannot be null. |
getExtras
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
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 one of the following: |
getText
fun getText(): CharSequence?
The translated text result.
| Return | |
|---|---|
CharSequence? |
This value may be null. |
getTransliteration
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
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 the following:
|