# A2uiOpenUrlFunction

Artifact: [androidx.a2ui:a2ui-model](https://developer.android.com/jetpack/androidx/releases/a2ui) [View Source](https://cs.android.com/search?q=file:androidx/a2ui/model/catalog/functions/A2uiOpenUrlFunction.kt+class:androidx.a2ui.model.catalog.functions.A2uiOpenUrlFunction) Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

*** ** * ** ***


```
class A2uiOpenUrlFunction : A2uiFunction
```

<br />

*** ** * ** ***

Opens a URL in a browser or handler.

Use this `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/A2uiFunction` to direct the user to an external link.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiOpenUrlFunction#A2uiOpenUrlFunction(androidx.a2ui.model.catalog.functions.A2uiUrlOpener)(urlOpener: https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiUrlOpener)` |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiOpenUrlFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)(args: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>, executionContext: https://developer.android.com/reference/kotlin/androidx/a2ui/model/protocol/A2uiExecutionContext)` Hands over the URL to open in `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiOpenUrlFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)` to the platform-specific URL opener. |

| ### Public properties |
|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/A2uiFunctionDefinition` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiOpenUrlFunction#definition()` The definition of the function. |

## Public constructors

### A2uiOpenUrlFunction

Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

```
A2uiOpenUrlFunction(urlOpener: A2uiUrlOpener)
```

## Public functions

### execute

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

Hands over the URL to open in `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiOpenUrlFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)` to the platform-specific URL opener.

| Parameters |
|---|---|
| `args: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | arguments containing the "url" string to open |
| `executionContext: https://developer.android.com/reference/kotlin/androidx/a2ui/model/protocol/A2uiExecutionContext` | context allowing to execute other functions, evaluate dynamic payloads and resolving data bindings |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` | null as this operation does not produce a return value |

## Public properties

### definition

```
open val definition: A2uiFunctionDefinition
```

The definition of the function.