# ClickAction

Artifact: [androidx.appsearch:appsearch](https://developer.android.com/jetpack/androidx/releases/appsearch) [View Source](https://cs.android.com/search?q=file:androidx/appsearch/usagereporting/ClickAction.java+class:androidx.appsearch.usagereporting.ClickAction) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

*** ** * ** ***


```
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.JOIN_SPEC_AND_QUALIFIED_ID)
@Document(name = "builtin:ClickAction")
@ExperimentalAppSearchApi
class ClickAction : TakenAction
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.appsearch.usagereporting.TakenAction](https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction) ||
|   | ↳ | [androidx.appsearch.usagereporting.ClickAction](https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction) |

*** ** * ** ***

`https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction` is a built-in AppSearch document type that contains different metrics. Clients can report the user's click actions on a `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document.

In order to use this document type, the client must explicitly set this schema type via `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SetSchemaRequest.Builder#addDocumentClasses(java.lang.Class<?>...)`.

Click actions can be used as signals to boost ranking via `https://developer.android.com/reference/kotlin/androidx/appsearch/app/JoinSpec` API in future search requests.

Since `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction` is an AppSearch document, the client can handle deletion via `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSession#removeAsync(androidx.appsearch.app.RemoveByDocumentIdRequest)` or document time-to-live (TTL). The default TTL is 60 days.

## Summary

| ### Nested types |
|---|
| `@https://developer.android.com/reference/kotlin/androidx/appsearch/annotation/Document.BuilderProducer class https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction.Builder : https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction.BuilderBase<https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction.Builder!>` Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction`. |
| `@https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi class https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction.BuilderBase<T : https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction.BuilderBase<T!>?> : https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction.BuilderBase<T!>` Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction`. |

| ### Public constructors |
|---|
| `@https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction#ClickAction(androidx.appsearch.usagereporting.ClickAction.BuilderBase<?>)(builder: https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction.BuilderBase<*>)` Constructs a `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction` from a `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction.BuilderBase`. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction#getQuery()()` Returns the user-entered search input (without any operators or rewriting) that yielded the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` on which the user clicked. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction#getReferencedQualifiedId()()` Returns the qualified id of the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document that the user clicked on. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction#getResultRankGlobal()()` Returns the global rank of the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction#getResultRankInBlock()()` Returns the rank of the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document among the user-defined block. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction#getTimeStayOnResultMillis()()` Returns the time in milliseconds that user stays on the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document after clicking it. |

### Inherited functions

From [androidx.appsearch.usagereporting.TakenAction](https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction#getActionTimestampMillis()()`

Returns the timestamp when the user took the action, in milliseconds since Unix epoch.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `@https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi
https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction#getActionType()()`

Returns the action type of the `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction#getDocumentTtlMillis()()`

Returns the time-to-live (TTL) of the `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction` document as a duration in milliseconds.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction#getId()()`

Returns the unique identifier of the `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction#getNamespace()()`

Returns the namespace of the `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/TakenAction`.

## Public constructors

### ClickAction

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

```
@ExperimentalAppSearchApi
ClickAction(builder: ClickAction.BuilderBase<*>)
```

Constructs a `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction` from a `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction.BuilderBase`.

| Parameters |
|---|---|
| `builder: https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction.BuilderBase<*>` | The builder to construct the `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction` from. |

## Public functions

### getQuery

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun getQuery(): String?
```

Returns the user-entered search input (without any operators or rewriting) that yielded the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` on which the user clicked.

### getReferencedQualifiedId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun getReferencedQualifiedId(): String?
```

Returns the qualified id of the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document that the user clicked on.

A qualified id is a string generated by package, database, namespace, and document id. See `https://developer.android.com/reference/kotlin/androidx/appsearch/util/DocumentIdUtil#createQualifiedId(java.lang.String,java.lang.String,java.lang.String,java.lang.String)` for more details.

### getResultRankGlobal

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun getResultRankGlobal(): Int
```

Returns the global rank of the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document.

Global rank reflects the order of `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` documents returned by AppSearch.

For example, AppSearch returns 2 pages with 10 `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` documents for each page. Then the global ranks of them will be 1 to 10 for the first page, and 11 to 20 for the second page.

If unset, then the global rank of the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document will be set to -1 to mark invalid.

### getResultRankInBlock

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun getResultRankInBlock(): Int
```

Returns the rank of the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document among the user-defined block.

The client can define its own custom definition for block, e.g. corpus name, group, etc.

For example, a client defines the block as corpus, and AppSearch returns 5 documents with corpus = \["corpus1", "corpus1", "corpus2", "corpus3", "corpus2"\]. Then the block ranks of them = \[1, 2, 1, 1, 2\].

If the client is not presenting the results in multiple blocks, they should set this value to match `https://developer.android.com/reference/kotlin/androidx/appsearch/usagereporting/ClickAction#getResultRankGlobal()`.

If unset, then the block rank of the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document will be set to -1 to mark invalid.

### getTimeStayOnResultMillis

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun getTimeStayOnResultMillis(): Long
```

Returns the time in milliseconds that user stays on the `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchResult` document after clicking it.