# PlatformImeOptions

Artifact: [androidx.compose.ui:ui-text](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/text/input/PlatformImeOptions.+class:androidx.compose.ui.text.input.PlatformImeOptions) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.6.0) Common/AllAndroid/JVM
- Cmn

  ```
  class PlatformImeOptions
  ```

*** ** * ** ***

Used to configure the platform specific IME options.

## Summary

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions#PlatformImeOptions(kotlin.String)(privateImeOptions: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` | android |

| ### Public functions |
|---|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | android |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions#hashCode()()` | android |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions#toString()()` | android |

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions#privateImeOptions()` defines a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` for supplying additional information options that are private to a particular IME implementation. | android |

| ### Extension functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions` | `@https://developer.android.com/reference/kotlin/androidx/tv/foundation/ExperimentalTvFoundationApi https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions.https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions#(androidx.compose.ui.text.input.PlatformImeOptions).keyboardAlignment(androidx.tv.foundation.text.TvKeyboardAlignment)( horizontalAlignment: https://developer.android.com/reference/kotlin/androidx/tv/foundation/text/TvKeyboardAlignment )` Adds the keyboard alignment option to the private IME configuration options. | android |

## Public constructors

### PlatformImeOptions

android Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.7.0)

```
PlatformImeOptions(privateImeOptions: String? = null)
```

| Parameters |
|---|---|
| `privateImeOptions: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | defines a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` for supplying additional information options that are private to a particular IME implementation. |

## Public functions

### equals

android

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

android

```
open fun hashCode(): Int
```

### toString

android

```
open fun toString(): String
```

## Public properties

### privateImeOptions

android Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.7.0)

```
val privateImeOptions: String?
```

defines a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` for supplying additional information options that are private to a particular IME implementation.

## Extension functions

### PlatformImeOptions.keyboardAlignment

android Artifact: [androidx.tv:tv-foundation](https://developer.android.com/jetpack/androidx/releases/tv) [View Source](https://cs.android.com/search?q=file:androidx/tv/foundation/text/TvImeOptions.kt+function:keyboardAlignment)

```
@ExperimentalTvFoundationApi
fun PlatformImeOptions.keyboardAlignment(
    horizontalAlignment: TvKeyboardAlignment
): PlatformImeOptions
```

Adds the keyboard alignment option to the private IME configuration options.

It is not guaranteed if IME will comply with the options provided here.

| Parameters |
|---|---|
| `horizontalAlignment: https://developer.android.com/reference/kotlin/androidx/tv/foundation/text/TvKeyboardAlignment` | defines the horizontal alignment `https://developer.android.com/reference/kotlin/androidx/tv/foundation/text/TvKeyboardAlignment` option for keyboard. |