actions are functions that can be invoked within a Nativeblocks Studio to perform specific tasks or operations. These annotations provide metadata and define configurable properties, data inputs, and events for your actions, making them usable as building actions in a visual editor.
Purpose: Marks a class or function as an action.
Parameters:
name: The display name of the action in the visual editor.keyType: A unique key used to identify the action type.description: A brief description of the action's functionality.
Example:
@NativeAction(
keyType = "XBOT",
name = "X bot",
description = "This is a bot"
)Purpose: Defines a configurable property for the action. These properties can be set visually in the editor.
Parameters:
description: (Optional) A description of the property.valuePicker: (Optional) Specifies the type of UI element used to edit the property (e.g., dropdown, text field).valuePickerGroup: (Optional) Specifies the group name of the property to group all related properties.valuePickerOptions: (Optional) Provides options for dropdown value pickers.
Example:
@NativeActionProp(description = "api key") apiKey: StringPurpose: Marks a parameter as a data input for the action. This data can be provided directly without visual configuration, often from other actions or data sources.
Parameters:
description: (Optional) A description of the data input.
Example:
@NativeActionData(description = "user input value") userPrompt: StringPurpose: Defines an event that the action can trigger, such as success, failure, or next updates.
Parameters:
description: (Optional) A description of the data input.then: Specifies when the event should be triggered (e.g., success, failure, next, end).dataBinding: (Optional) An array of data input names to bind to the event handler parameters.
Example:
@NativeActionEvent(
then = Then.SUCCESS,
dataBinding = ["result"]
)This example demonstrates a bot action with configurable properties (apiKey, aiModelId), data inputs (userPrompt, result, errorMessage), and events for success (onMessageStream) and failure (onError).
@NativeAction(
keyType = "XBOT",
name = "X bot",
description = "This is a bot"
)
class XBot {
@NativeActionParameter
data class Parameters(
@NativeActionProp
val apiKey: String,
@NativeActionProp
val aiModelId: String,
@NativeActionData
val userPrompt: String,
@NativeActionData
val result: String,
@NativeActionData
val errorMessage: String,
@NativeActionEvent(
then = Then.SUCCESS,
dataBinding = ["result"]
)
val onMessageStream: (String) -> Unit,
@NativeActionEvent(
then = Then.FAILURE,
dataBinding = ["errorMessage"]
)
val onError: (String) -> Unit
)
@NativeActionFunction
suspend fun ask(parameters: Parameters) {
// ... Action implementation ...
}
}