A2uiFormatCurrencyFunction


class A2uiFormatCurrencyFunction : A2uiFunction


Formats a number as a currency string.

Use this A2uiFunction to display monetary values.

Summary

Public companion properties

A2uiFormatCurrencyFunction

Public constructors

Public functions

open Any?
execute(args: Map<StringAny>, executionContext: A2uiExecutionContext)

Formats the monetary number into a currency string based on args.

Public properties

open A2uiFunctionDefinition

The definition of the function.

Public companion properties

Public constructors

A2uiFormatCurrencyFunction

Added in 1.0.0-alpha01
A2uiFormatCurrencyFunction(
    localeProvider: A2uiLocaleProvider = A2uiLocaleProvider.Default
)

Public functions

execute

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

Formats the monetary number into a currency string based on args.

Parameters
args: Map<StringAny>

arguments conforming of the schema within definition

executionContext: A2uiExecutionContext

context allowing to execute other functions, evaluate dynamic payloads and resolving data bindings

Returns
Any?

the formatted currency string, or null if required values are missing

Public properties

definition

open val definitionA2uiFunctionDefinition

The definition of the function.