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/TranslationRequest#nestedclasses) \| [Constants](https://developer.android.com/reference/android/view/translation/TranslationRequest#constants) \| [Inherited Constants](https://developer.android.com/reference/android/view/translation/TranslationRequest#inhconstants) \| [Fields](https://developer.android.com/reference/android/view/translation/TranslationRequest#lfields) \| [Methods](https://developer.android.com/reference/android/view/translation/TranslationRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/translation/TranslationRequest#inhmethods)

# TranslationRequest

*** ** * ** ***


`
public

final

class
TranslationRequest
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.translation.TranslationRequest |

<br />

*** ** * ** ***

Translation request sent to the translation service by the
`https://developer.android.com/reference/android/view/translation/Translator` which contains the text to be translated.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/view/translation/TranslationRequest.Builder` A builder for `https://developer.android.com/reference/android/view/translation/TranslationRequest` |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_DICTIONARY_RESULT` Indicates this request wants to receive the dictionary result. |
| `int` | `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_PARTIAL_RESPONSES` Indicates this request is willing to accept partial responses. |
| `int` | `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLATION_RESULT` Indicates this request wants to receive the standard translation result. |
| `int` | `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLITERATION_RESULT` Indicates this request wants to receive the transliteration result. |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/view/translation/TranslationRequest>` | `https://developer.android.com/reference/android/view/translation/TranslationRequest#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/view/translation/TranslationRequest#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/view/translation/TranslationRequest#getFlags()() ` Request flags. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/view/translation/TranslationRequestValue>` | ` https://developer.android.com/reference/android/view/translation/TranslationRequest#getTranslationRequestValues()() ` List of `https://developer.android.com/reference/android/view/translation/TranslationRequestValue`s to be translated. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/view/translation/ViewTranslationRequest>` | ` https://developer.android.com/reference/android/view/translation/TranslationRequest#getViewTranslationRequests()() ` List of `https://developer.android.com/reference/android/view/translation/ViewTranslationRequest`s to be translated. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/view/translation/TranslationRequest#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/view/translation/TranslationRequest#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` 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 https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` 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` | ` 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` | ` 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 ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` 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` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||

## Constants

### FLAG_DICTIONARY_RESULT

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_DICTIONARY_RESULT
```

Indicates this request wants to receive the dictionary result.

See `https://developer.android.com/reference/android/view/translation/TranslationResponseValue#EXTRA_DEFINITIONS` for more detail on the structure
of the returned data.


Value is either `0` or a combination of the following:

- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLATION_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_DICTIONARY_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLITERATION_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_PARTIAL_RESPONSES`
  - Constant Value: 2 (0x00000002)

### FLAG_PARTIAL_RESPONSES

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_PARTIAL_RESPONSES
```

Indicates this request is willing to accept partial responses.

The partial responses can be accessed by
`https://developer.android.com/reference/android/view/translation/TranslationResponse#getTranslationResponseValues()` or
`https://developer.android.com/reference/android/view/translation/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 `https://developer.android.com/reference/android/view/translation/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 the following:

- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLATION_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_DICTIONARY_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLITERATION_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_PARTIAL_RESPONSES`
  - Constant Value: 8 (0x00000008)

### FLAG_TRANSLATION_RESULT

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 the following:

- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLATION_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_DICTIONARY_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLITERATION_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_PARTIAL_RESPONSES`
  - Constant Value: 1 (0x00000001)

### FLAG_TRANSLITERATION_RESULT

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getTransliteration()`.


Value is either `0` or a combination of the following:

- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLATION_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_DICTIONARY_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLITERATION_RESULT`
- `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_PARTIAL_RESPONSES`
  - Constant Value: 4 (0x00000004)

## Fields

### CREATOR

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<TranslationRequest> CREATOR
```

<br />

<br />

## 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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getFlags

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getFlags ()
```

Request flags. `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLATION_RESULT` by default.

<br />

| Returns ||
|---|---|
| `int` | Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLATION_RESULT` - `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_DICTIONARY_RESULT` - `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_TRANSLITERATION_RESULT` - `https://developer.android.com/reference/android/view/translation/TranslationRequest#FLAG_PARTIAL_RESPONSES` |

### getTranslationRequestValues

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<TranslationRequestValue> getTranslationRequestValues ()
```

List of `https://developer.android.com/reference/android/view/translation/TranslationRequestValue`s to be translated. The index of entries in this list
will be their respective key in the `https://developer.android.com/reference/android/util/SparseArray` returned by calling
`https://developer.android.com/reference/android/view/translation/TranslationResponse#getTranslationResponseValues()`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/view/translation/TranslationRequestValue>` | This value cannot be `null`. <br /> |

### getViewTranslationRequests

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<ViewTranslationRequest> getViewTranslationRequests ()
```

List of `https://developer.android.com/reference/android/view/translation/ViewTranslationRequest`s to be translated. The index of entries in this list
will be their respective key in the `https://developer.android.com/reference/android/util/SparseArray` returned by calling
`https://developer.android.com/reference/android/view/translation/TranslationResponse#getViewTranslationResponses()`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/view/translation/ViewTranslationRequest>` | This value cannot be `null`. <br /> |

### 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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### 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.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |