# TranslationResponse.Builder

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

# Builder

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/view/translation/TranslationResponse.Builder "View this page in Java")  

```
class Builder
```

|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                               ||
| ↳ | [android.view.translation.TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) |

A builder for[TranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse)

## Summary

|                                                                                                                        Public constructors                                                                                                                        ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#Builder(kotlin.Int))`(`translationStatus:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Creates a new Builder. |

|                                                                                                                                                                                                                                                                                                                                                                          Public methods                                                                                                                                                                                                                                                                                                                                                                          ||
|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [TranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse)                  | [build](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#build())`()` Builds the instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | [setFinalResponse](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#setFinalResponse(kotlin.Boolean))`(`value:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Whether this response contains complete translated values, or is the final response in a series of partial responses.                                                                                                                                                                                                                                             |
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | [setTranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#setTranslationResponseValue(kotlin.Int,%20android.view.translation.TranslationResponseValue))`(`index:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `value:` `[TranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue)`)` Adds[TranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue)to be translated.         |
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | [setTranslationResponseValues](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#setTranslationResponseValues(android.util.SparseArray))`(`value:` `[SparseArray](https://developer.android.com/reference/kotlin/android/util/SparseArray.html#)<[TranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue)!>`)` List of translated[TranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue)s.                                       |
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | [setViewTranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#setViewTranslationResponse(kotlin.Int,%20android.view.translation.ViewTranslationResponse))`(`index:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `response:` `[ViewTranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/ViewTranslationResponse)`)` Sets the list of[ViewTranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/ViewTranslationResponse)to be translated. |
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | [setViewTranslationResponses](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#setViewTranslationResponses(android.util.SparseArray))`(`value:` `[SparseArray](https://developer.android.com/reference/kotlin/android/util/SparseArray.html#)<[ViewTranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/ViewTranslationResponse)!>`)` List of translated[ViewTranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/ViewTranslationResponse)s.                                             |

## Public constructors

### Builder

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

```
Builder(translationStatus: Int)
```

Creates a new Builder.

|                                                                                                                                                                                                                                                                                                                                                                                                        Parameters                                                                                                                                                                                                                                                                                                                                                                                                         ||
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `translationStatus` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The translation result status code. Value is[android.view.translation.TranslationResponse#TRANSLATION_STATUS_SUCCESS](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse#TRANSLATION_STATUS_SUCCESS:kotlin.Int),[android.view.translation.TranslationResponse#TRANSLATION_STATUS_UNKNOWN_ERROR](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse#TRANSLATION_STATUS_UNKNOWN_ERROR:kotlin.Int), or[android.view.translation.TranslationResponse#TRANSLATION_STATUS_CONTEXT_UNSUPPORTED](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse#TRANSLATION_STATUS_CONTEXT_UNSUPPORTED:kotlin.Int) |

## Public methods

### build

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

```
fun build(): TranslationResponse
```

Builds the instance. This builder should not be touched after calling this!

|                                                                     Return                                                                      ||
|--------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [TranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse) | This value cannot be`null`. |

### setFinalResponse

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

```
fun setFinalResponse(value: Boolean): TranslationResponse.Builder
```

Whether this response contains complete translated values, or is the final response in a series of partial responses.

This is`true`by default.

|                                                                              Return                                                                              ||
|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | This value cannot be`null`. |

### setTranslationResponseValue

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

```
fun setTranslationResponseValue(
    index: Int, 
    value: TranslationResponseValue
): TranslationResponse.Builder
```

Adds[TranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue)to be translated. The input TranslationResponseValue format should match those provided by the[android.view.translation.Translator](https://developer.android.com/reference/kotlin/android/view/translation/Translator)'s targetSpec.

|                                                                                       Parameters                                                                                        ||
|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `value` | [TranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue):the translated value. This value cannot be`null`. |

|                                                                                     Return                                                                                     ||
|-------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | this Builder. This value cannot be`null`. |

### setTranslationResponseValues

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

```
fun setTranslationResponseValues(value: SparseArray<TranslationResponseValue!>): TranslationResponse.Builder
```

List of translated[TranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue)s. The key of entries in this list will be their respective index in[TranslationRequest.getTranslationRequestValues()](https://developer.android.com/reference/kotlin/android/view/translation/TranslationRequest#getTranslationRequestValues()).

|                                                                                                                             Parameters                                                                                                                             ||
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `value` | [SparseArray](https://developer.android.com/reference/kotlin/android/util/SparseArray.html#)\<[TranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue)!\>:This value cannot be`null`. |

|                                                                              Return                                                                              ||
|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | This value cannot be`null`. |

### setViewTranslationResponse

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

```
fun setViewTranslationResponse(
    index: Int, 
    response: ViewTranslationResponse
): TranslationResponse.Builder
```

Sets the list of[ViewTranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/ViewTranslationResponse)to be translated. The input ViewTranslationResponse contains[TranslationResponseValue](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponseValue)s whose format should match those provided by the[android.view.translation.Translator](https://developer.android.com/reference/kotlin/android/view/translation/Translator)'s targetSpec.

|                                                                                         Parameters                                                                                          ||
|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `response` | [ViewTranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/ViewTranslationResponse):the translated response. This value cannot be`null`. |

|                                                                                     Return                                                                                     ||
|-------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | this Builder. This value cannot be`null`. |

### setViewTranslationResponses

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

```
fun setViewTranslationResponses(value: SparseArray<ViewTranslationResponse!>): TranslationResponse.Builder
```

List of translated[ViewTranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/ViewTranslationResponse)s. The key of entries in this list will be their respective index in[TranslationRequest.getViewTranslationRequests()](https://developer.android.com/reference/kotlin/android/view/translation/TranslationRequest#getViewTranslationRequests()).

|                                                                                                                            Parameters                                                                                                                            ||
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `value` | [SparseArray](https://developer.android.com/reference/kotlin/android/util/SparseArray.html#)\<[ViewTranslationResponse](https://developer.android.com/reference/kotlin/android/view/translation/ViewTranslationResponse)!\>:This value cannot be`null`. |

|                                                                              Return                                                                              ||
|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [TranslationResponse.Builder](https://developer.android.com/reference/kotlin/android/view/translation/TranslationResponse.Builder#) | This value cannot be`null`. |