# FeaturedCluster

# FeaturedCluster

*** ** * ** ***

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

<br />

```
class FeaturedCluster
```

<br />

*** ** * ** ***

A list of featured entities.

## Summary

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

|                                                                                                                                                ### Public functions                                                                                                                                                 |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [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/FeaturedCluster#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/FeaturedCluster#getDisplayTimeWindows())`()` Returns the display time windows associated with the cluster.                                                            |
| `(`[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/FeaturedCluster#getEntities())`()` Returns the list of[Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity)in the Cluster. |

## Public functions

### getClusterType

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

### getDisplayTimeWindows

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

Returns the display time windows associated with the cluster.  

### 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.