Added in API level 31

TranslationRequest

Kotlin |Java

public final class TranslationRequest
extends Object implements Parcelable

java.lang.Object
↳	android.view.translation.TranslationRequest

Translation request sent to the translation service by the Translator which contains the text to be translated.

Summary

Nested classes
`class`	`TranslationRequest.Builder` A builder for `TranslationRequest`

Constants
`int`	`FLAG_DICTIONARY_RESULT` Indicates this request wants to receive the dictionary result.
`int`	`FLAG_PARTIAL_RESPONSES` Indicates this request is willing to accept partial responses.
`int`	`FLAG_TRANSLATION_RESULT` Indicates this request wants to receive the standard translation result.
`int`	`FLAG_TRANSLITERATION_RESULT` Indicates this request wants to receive the transliteration result.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: 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<TranslationRequest>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getFlags()` Request flags.
`List<TranslationRequestValue>`	`getTranslationRequestValues()` List of `TranslationRequestValue`s to be translated.
`List<ViewTranslationRequest>`	`getViewTranslationRequests()` List of `ViewTranslationRequest`s to be translated.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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(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()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

FLAG_DICTIONARY_RESULT

Added in API level 31

public static final int FLAG_DICTIONARY_RESULT

Indicates this request wants to receive the dictionary result.

See TranslationResponseValue#EXTRA_DEFINITIONS for more detail on the structure of the returned data.
Value is either 0 or a combination of FLAG_TRANSLATION_RESULT, FLAG_DICTIONARY_RESULT, FLAG_TRANSLITERATION_RESULT, and FLAG_PARTIAL_RESPONSES

Constant Value: 2 (0x00000002)

FLAG_PARTIAL_RESPONSES

Added in API level 31

public static final int FLAG_PARTIAL_RESPONSES

Indicates this request is willing to accept partial responses.

The partial responses can be accessed by TranslationResponse#getTranslationResponseValues() or TranslationResponse#getViewTranslationResponses(). These responses will each contain only a subset of the corresponding translated values.

The are no guarantees to the number of translated values or the order in which these values are returned in the TranslationResponse.

This flag denotes the client can expect multiple partial responses, but there may not necessarily be multiple responses.

Value is either 0 or a combination of FLAG_TRANSLATION_RESULT, FLAG_DICTIONARY_RESULT, FLAG_TRANSLITERATION_RESULT, and FLAG_PARTIAL_RESPONSES

Constant Value: 8 (0x00000008)

FLAG_TRANSLATION_RESULT

Added in API level 31

public static final int FLAG_TRANSLATION_RESULT

Indicates this request wants to receive the standard translation result.
Value is either 0 or a combination of FLAG_TRANSLATION_RESULT, FLAG_DICTIONARY_RESULT, FLAG_TRANSLITERATION_RESULT, and FLAG_PARTIAL_RESPONSES

Constant Value: 1 (0x00000001)

FLAG_TRANSLITERATION_RESULT

Added in API level 31

public static final int FLAG_TRANSLITERATION_RESULT

Indicates this request wants to receive the transliteration result.

This returns a CharSequence representation of the transliteration of the translated text. See TranslationResponseValue#getTransliteration().
Value is either 0 or a combination of FLAG_TRANSLATION_RESULT, FLAG_DICTIONARY_RESULT, FLAG_TRANSLITERATION_RESULT, and FLAG_PARTIAL_RESPONSES

Constant Value: 4 (0x00000004)

Fields

CREATOR

Added in API level 31

public static final Creator<TranslationRequest> CREATOR

Public methods

describeContents

Added in API level 31

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), the return value of this method must include the 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`

getFlags

Added in API level 31

public int getFlags ()

Request flags. FLAG_TRANSLATION_RESULT by default.

Returns
`int`	Value is either `0` or a combination of `FLAG_TRANSLATION_RESULT`, `FLAG_DICTIONARY_RESULT`, `FLAG_TRANSLITERATION_RESULT`, and `FLAG_PARTIAL_RESPONSES`

getTranslationRequestValues

Added in API level 31

public List<TranslationRequestValue> getTranslationRequestValues ()

List of TranslationRequestValues to be translated. The index of entries in this list will be their respective key in the SparseArray returned by calling TranslationResponse#getTranslationResponseValues().

Returns
`List<TranslationRequestValue>`	This value cannot be `null`.

getViewTranslationRequests

Added in API level 31

public List<ViewTranslationRequest> getViewTranslationRequests ()

List of ViewTranslationRequests to be translated. The index of entries in this list will be their respective key in the SparseArray returned by calling TranslationResponse#getViewTranslationResponses().

Returns
`List<ViewTranslationRequest>`	This value cannot be `null`.

toString

Added in API level 31

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 31

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

TranslationRequest

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

FLAG_DICTIONARY_RESULT

FLAG_PARTIAL_RESPONSES

FLAG_TRANSLATION_RESULT

FLAG_TRANSLITERATION_RESULT

Fields

CREATOR

Public methods

describeContents

getFlags

getTranslationRequestValues

getViewTranslationRequests

toString

writeToParcel