A2uiOpenUrlFunction


public final class A2uiOpenUrlFunction implements A2uiFunction


Opens a URL in a browser or handler.

Use this A2uiFunction to direct the user to an external link.

Summary

Public constructors

Public methods

Object
execute(
    @NonNull Map<@NonNull String, @NonNull Object> args,
    @NonNull A2uiExecutionContext executionContext
)

Hands over the URL to open in args to the platform-specific URL opener.

@NonNull A2uiFunctionDefinition

The definition of the function.

Public constructors

A2uiOpenUrlFunction

Added in 1.0.0-alpha01
public A2uiOpenUrlFunction(@NonNull A2uiUrlOpener urlOpener)

Public methods

execute

public Object execute(
    @NonNull Map<@NonNull String, @NonNull Object> args,
    @NonNull A2uiExecutionContext executionContext
)

Hands over the URL to open in args to the platform-specific URL opener.

Parameters
@NonNull Map<@NonNull String, @NonNull Object> args

arguments containing the "url" string to open

@NonNull A2uiExecutionContext executionContext

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

Returns
Object

null as this operation does not produce a return value

getDefinition

public @NonNull A2uiFunctionDefinition getDefinition()

The definition of the function.