# MutableActionParameters

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/action/ActionParameters.kt+class:androidx.glance.action.MutableActionParameters) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)


```
class MutableActionParameters : ActionParameters
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.glance.action.ActionParameters](https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters) ||
|   | ↳ | [androidx.glance.action.MutableActionParameters](https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters) |

*** ** * ** ***

Mutable version of `https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters`. Allows for editing the underlying data, and adding or removing key-value pairs.

## Summary

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | `https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#asMap()()` Retrieves a map of all key value pairs. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#clear()()` Removes all parameters from this MutableParameters. |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#contains(androidx.glance.action.ActionParameters.Key)(key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>)` Returns true if the Parameters set contains the given Key. |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open operator T?` | `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#get(androidx.glance.action.ActionParameters.Key)(key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>)` Get a parameter with a key. |
| `open T` | `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#getOrDefault(androidx.glance.action.ActionParameters.Key,kotlin.Any)(key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>, defaultValue: T)` Get a parameter with a key. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#isEmpty()()` Returns whether there are any keys stored in the parameters. |
| `T?` | `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#remove(androidx.glance.action.ActionParameters.Key)(key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>)` Removes an item from this MutableParameters. |
| `operator T?` | `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#set(androidx.glance.action.ActionParameters.Key,kotlin.Any)(key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>, value: T?)` Sets a key value pair in MutableParameters. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/glance/action/MutableActionParameters#toString()()` |

## Public functions

### asMap

```
open fun asMap(): Map<ActionParameters.Key<Any>, Any>
```

Retrieves a map of all key value pairs. The map is unmodifiable, and attempts to mutate it will throw runtime exceptions.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | a map of all parameters in this Parameters |

### clear

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
fun clear(): Unit
```

Removes all parameters from this MutableParameters.

### contains

```
open operator fun <T : Any> contains(key: ActionParameters.Key<T>): Boolean
```

Returns true if the Parameters set contains the given Key.

| Parameters |
|---|---|
| `key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>` | the key to check for |

### equals

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

### get

```
open operator fun <T : Any> get(key: ActionParameters.Key<T>): T?
```

Get a parameter with a key. If the key is not set, returns null.

| Parameters |
|---|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | the type of the parameter |
| `key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>` | the key for the parameter |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-class-cast-exception/index.html` | if there is something stored with the same name as `https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters#get(androidx.glance.action.ActionParameters.Key)` but it cannot be cast to T |

### getOrDefault

```
open fun <T : Any> getOrDefault(key: ActionParameters.Key<T>, defaultValue: T): T
```

Get a parameter with a key. If the key is not set, returns the provided default value.

| Parameters |
|---|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | the type of the parameter |
| `key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>` | the key for the parameter |
| `defaultValue: T` | the default value to return if key is missing |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-class-cast-exception/index.html` | if there is something stored with the same name as `https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters#getOrDefault(androidx.glance.action.ActionParameters.Key,kotlin.Any)` but it cannot be cast to T |

### hashCode

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

### isEmpty

```
open fun isEmpty(): Boolean
```

Returns whether there are any keys stored in the parameters.

### remove

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
fun <T : Any> remove(key: ActionParameters.Key<T>): T?
```

Removes an item from this MutableParameters.

| Parameters |
|---|---|
| `key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>` | the parameter to remove |

| Returns |
|---|---|
| `T?` | the original value of the parameter |

### set

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
operator fun <T : Any> set(key: ActionParameters.Key<T>, value: T?): T?
```

Sets a key value pair in MutableParameters. If the value is null, the key is removed from the parameters.

| Parameters |
|---|---|
| `key: https://developer.android.com/reference/kotlin/androidx/glance/action/ActionParameters.Key<T>` | the parameter to set |
| `value: T?` | the value to assign to this parameter |

| Returns |
|---|---|
| `T?` | the previous value associated with the key, or null if the key was not present |

### toString

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