Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#inhmethods)

# SpellCheckerSession.SpellCheckerSessionParams.Builder

*** ** * ** ***


`
public
static
final

class
SpellCheckerSession.SpellCheckerSessionParams.Builder
`


`

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


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.textservice.SpellCheckerSession.SpellCheckerSessionParams.Builder |

<br />

*** ** * ** ***

Builder of `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams`.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#Builder()() ` Constructs a `Builder`. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#build()() ` Returns constructed `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession` instance. |
| ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setExtras(android.os.Bundle)(https://developer.android.com/reference/android/os/Bundle extras) ` Sets a bundle containing extra parameters for the spell checker. |
| ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setLocale(java.util.Locale)(https://developer.android.com/reference/java/util/Locale locale) ` Sets the locale in which the spell checker should operate. |
| ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setShouldReferToSpellCheckerLanguageSettings(boolean)(boolean shouldReferToSpellCheckerLanguageSettings) ` Sets whether or not the user's spell checker language settings should be used to determine spell checker locale. |
| ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setSupportedAttributes(int)(int supportedAttributes) ` Sets a bitmask of `https://developer.android.com/reference/android/view/textservice/SuggestionsInfo` attributes that the spell checker can set in `https://developer.android.com/reference/android/view/textservice/SuggestionsInfo` it returns. |

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

## Public constructors

### Builder

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

```
public Builder ()
```

Constructs a `Builder`.

<br />

## Public methods

### build

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

```
public SpellCheckerSession.SpellCheckerSessionParams build ()
```

Returns constructed `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession` instance.

Before calling this method, either `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setLocale(java.util.Locale)` should be called
with a non-null locale or
`https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setShouldReferToSpellCheckerLanguageSettings(boolean)` should be called with
`true`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams` | <br /> |

### setExtras

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

```
public SpellCheckerSession.SpellCheckerSessionParams.Builder setExtras (Bundle extras)
```

Sets a bundle containing extra parameters for the spell checker.

This bundle can be used to pass implementation-specific parameters to the
`https://developer.android.com/reference/android/service/textservice/SpellCheckerService` implementation.

<br />

| Parameters ||
|---|---|
| `extras` | `Bundle`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/service/textservice/SpellCheckerService.Session#getBundle()`

### setLocale

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

```
public SpellCheckerSession.SpellCheckerSessionParams.Builder setLocale (Locale locale)
```

Sets the locale in which the spell checker should operate.

<br />

| Parameters ||
|---|---|
| `locale` | `Locale`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/service/textservice/SpellCheckerService.Session#getLocale()`

### setShouldReferToSpellCheckerLanguageSettings

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

```
public SpellCheckerSession.SpellCheckerSessionParams.Builder setShouldReferToSpellCheckerLanguageSettings (boolean shouldReferToSpellCheckerLanguageSettings)
```

Sets whether or not the user's spell checker language settings should be used to
determine spell checker locale.

If `shouldReferToSpellCheckerLanguageSettings` is true, the exact way of
determining spell checker locale differs based on `locale` specified in
`https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setLocale(java.util.Locale)`.
If `shouldReferToSpellCheckerLanguageSettings` is true and `locale` is
null, the locale specified in Settings will be used. If
`shouldReferToSpellCheckerLanguageSettings` is true and `locale` is not
null, `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession` can be created only when the locale specified in
Settings is the same as `locale`. Exceptionally, if
`shouldReferToSpellCheckerLanguageSettings` is true and `locale` is
language only (e.g. "en"), the specified locale in Settings (e.g. "en_US") will be
used.

<br />

| Parameters ||
|---|---|
| `shouldReferToSpellCheckerLanguageSettings` | `boolean` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder` | <br /> |

**See also:**

- `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder#setLocale(java.util.Locale)`

### setSupportedAttributes

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

```
public SpellCheckerSession.SpellCheckerSessionParams.Builder setSupportedAttributes (int supportedAttributes)
```

Sets a bitmask of `https://developer.android.com/reference/android/view/textservice/SuggestionsInfo` attributes that the spell checker can set
in `https://developer.android.com/reference/android/view/textservice/SuggestionsInfo` it returns.

<br />

| Parameters ||
|---|---|
| `supportedAttributes` | `int`: Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY` - `https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO` - `https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS` - `https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_GRAMMAR_ERROR` - `https://developer.android.com/reference/android/view/textservice/SuggestionsInfo#RESULT_ATTR_DONT_SHOW_UI_FOR_SUGGESTIONS` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/textservice/SpellCheckerSession.SpellCheckerSessionParams.Builder` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/service/textservice/SpellCheckerService.Session#getSupportedAttributes()`