# A2uiFormatCurrencyFunction

Artifact: [androidx.a2ui:a2ui-model](https://developer.android.com/jetpack/androidx/releases/a2ui) [View Source](https://cs.android.com/search?q=file:androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction.kt+class:androidx.a2ui.model.catalog.functions.A2uiFormatCurrencyFunction) Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

*** ** * ** ***


```
class A2uiFormatCurrencyFunction : A2uiFunction
```

<br />

*** ** * ** ***

Formats a number as a currency string.

Use this `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/A2uiFunction` to display monetary values.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#INSTANCE()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#A2uiFormatCurrencyFunction(androidx.a2ui.model.catalog.functions.A2uiLocaleProvider)(localeProvider: https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiLocaleProvider)` |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)(args: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>, executionContext: https://developer.android.com/reference/kotlin/androidx/a2ui/model/protocol/A2uiExecutionContext)` Formats the monetary number into a currency string based on `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)`. |

| ### Public properties |
|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/A2uiFunctionDefinition` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#definition()` The definition of the function. |

## Public companion properties

### INSTANCE

```
val INSTANCE: A2uiFormatCurrencyFunction
```

## Public constructors

### A2uiFormatCurrencyFunction

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

```
A2uiFormatCurrencyFunction(
    localeProvider: A2uiLocaleProvider = A2uiLocaleProvider.Default
)
```

## Public functions

### execute

```
open fun execute(args: Map<String, Any>, executionContext: A2uiExecutionContext): Any?
```

Formats the monetary number into a currency string based on `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)`.

| Parameters |
|---|---|
| `args: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | arguments conforming of the schema within `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#definition()` |
| `executionContext: https://developer.android.com/reference/kotlin/androidx/a2ui/model/protocol/A2uiExecutionContext` | context allowing to execute other functions, evaluate dynamic payloads and resolving data bindings |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` | the formatted currency string, or null if required values are missing |

## Public properties

### definition

```
open val definition: A2uiFunctionDefinition
```

The definition of the function.