A2uiPluralizeFunction


class A2uiPluralizeFunction : A2uiFunction


Chooses a plural string form based on a numeric value.

Use this A2uiFunction to get localized plural categories.

Summary

Public constructors

A2uiPluralizeFunction(
    messageFormatter: A2uiMessageFormatter,
    localeProvider: A2uiLocaleProvider
)

Public functions

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

Returns the matching plural form based on count in args.

Public properties

open A2uiFunctionDefinition

The definition of the function.

Public constructors

A2uiPluralizeFunction

Added in 1.0.0-alpha01
A2uiPluralizeFunction(
    messageFormatter: A2uiMessageFormatter,
    localeProvider: A2uiLocaleProvider = A2uiLocaleProvider.Default
)

Public functions

execute

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

Returns the matching plural form based on count in args.

Parameters
args: Map<StringAny>

arguments containing the count "value" and plural form strings

executionContext: A2uiExecutionContext

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

Returns
Any?

the selected plural form, or null if count or default fallback is missing

Public properties

definition

open val definitionA2uiFunctionDefinition

The definition of the function.