AppFunctionStringValueConstraint

@Retention(value = AnnotationRetention.BINARY)
@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])
annotation AppFunctionStringValueConstraint

Specifies constraints applied on the string values for return types, parameters, or properties in app functions.

This annotation can be applied to:

  • functions annotated with @AppFunction (to constrain the return value),

  • parameters of @AppFunction,

  • or properties within an @AppFunctionSerializable.

Usage Example:

// Constraining a function return value:
@AppFunction
@AppFunctionStringValueConstraint(enumValues = ["LOW", "MEDIUM", "HIGH"])
fun getPriorityLevel(): String {
    // Function body
}

// Constraining a parameter:
@AppFunction
fun setMode(
    @AppFunctionStringValueConstraint(enumValues = ["AUTO", "MANUAL"])
    mode: String
) {
    // Function body
}

// Constraining a property within an AppFunctionSerializable:
@AppFunctionSerializable
data class AppConfig(
    @AppFunctionStringValueConstraint(enumValues = ["ENABLED", "DISABLED"])
    val featureFlag: String
)

Summary

Public constructors

Public properties
Array<String>

The list of allowed string values for the annotated element.

Public constructors

AppFunctionStringValueConstraint

Added in 1.0.0-alpha03
AppFunctionStringValueConstraint(enumValues: Array<String> = [])

Public properties

enumValues

val enumValues: Array<String>

The list of allowed string values for the annotated element.

These values are communicated to the agent or framework that interprets or invokes the @AppFunction. If any of the values carry special meaning (e.g., "AUTO" means automatic mode), such meanings should be documented clearly in the corresponding property, parameter, or function return KDoc.