# RecommendationCluster

# RecommendationCluster

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/com/google/android/engage/common/datamodel/RecommendationCluster "View this page in Java")  

<br />

```
class RecommendationCluster
```

<br />

*** ** * ** ***

A list of entities for recommendation.

## Summary

|                                                                                                                                                      ### Nested types                                                                                                                                                       |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[RecommendationCluster.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster.Builder) Builder class for[RecommendationCluster](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster). |

|                                                                                                                                                ### Public functions                                                                                                                                                 |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                   | [getActionText](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster#getActionText())`()` Returns the action text associated with the[RecommendationCluster](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster).                          |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Uri](https://developer.android.com/reference/android/net/Uri.html)`!>!`                                                                                                                                                | [getActionUri](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster#getActionUri())`()` Returns the action Uri which user is navigated to on clicking the action text of .                                                                                                                              |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                                                                                                                                                                                                                          | [getClusterType](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster#getClusterType())`()`                                                                                                                                                                                                             |
| [ImmutableList](https://guava.dev/releases/21.0/api/docs/com/google/common/collect/ImmutableList.html)`<`[DisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/DisplayTimeWindow)`!>!`                                                                      | [getDisplayTimeWindows](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster#getDisplayTimeWindows())`()` Returns the display time windows associated with the[RecommendationCluster](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster). |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity)`!>!` | [getEntities](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster#getEntities())`()` Returns the list of[Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity)in the Cluster.                                                                      |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                   | [getSubtitle](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster#getSubtitle())`()` Returns the subtitle of[RecommendationCluster](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster).                                                  |

|                                ### Public properties                                |
|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)          | `@`[RecommendationClusterType](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationClusterType) [recommendationClusterType](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster#recommendationClusterType()) |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!` | [title](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster#title())                                                                                                                                                                                             |

## Public functions

### getActionText

```
fun getActionText(): Optional<String!>!
```

Returns the action text associated with the[RecommendationCluster](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster).  

### getActionUri

```
fun getActionUri(): Optional<Uri!>!
```

Returns the action Uri which user is navigated to on clicking the action text of .  

### getClusterType

```
fun getClusterType(): Int
```  

### getDisplayTimeWindows

```
fun getDisplayTimeWindows(): ImmutableList<DisplayTimeWindow!>!
```

Returns the display time windows associated with the[RecommendationCluster](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster).  

### getEntities

```
fun getEntities(): (Mutable)List<Entity!>!
```

Returns the list of[Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity)in the Cluster.  

### getSubtitle

```
fun getSubtitle(): Optional<String!>!
```

Returns the subtitle of[RecommendationCluster](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/RecommendationCluster).  

## Public properties

### recommendationClusterType

```
@RecommendationClusterType
val recommendationClusterType: Int
```  

### title

```
val title: String!
```