# PersonEntity

# PersonEntity

*** ** * ** ***

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

<br />

```
class PersonEntity : Entity
```

<br />

|---|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                       |||
| ↳ | [com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity)                ||
|   | ↳ | [com.google.android.engage.social.datamodel.PersonEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity) |

*** ** * ** ***

An object representing a Person Entity.

## Summary

|                                                                                                                                                                                                                                                                                                         ### Nested types                                                                                                                                                                                                                                                                                                         |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[PersonEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity.Builder) Builder class for[PersonEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity).                                                                                                                                                                                                                                                                                                                                          |
| `@`[IntDef](https://developer.android.com/reference/androidx/annotation/IntDef.html)`(value = [EligibleContentCategory.TYPE_SPORTS, EligibleContentCategory.TYPE_HOME_AND_AUTO, EligibleContentCategory.TYPE_HEALTH_AND_FITNESS, EligibleContentCategory.TYPE_DATING])` `@`[Retention](https://developer.android.com/reference/java/lang/annotation/Retention.html)`(value = RetentionPolicy.SOURCE)` `annotation `[PersonEntity.EligibleContentCategory](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity.EligibleContentCategory) Content category of the person entity. |

|                                                                                                                                               ### Public functions                                                                                                                                                |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)`!`                                                                                                                                                                                                                                            | [getActionLinkUri](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getActionLinkUri())`()` Returns the action link uri of the person entity.                                         |
| `(`[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)`<`[Badge](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Badge)`!>!` | [getBadgeList](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getBadgeList())`()` Returns the list of badges (image/text) for the person entity e.g. "Top pro", etc.                |
| `(`[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)`<`[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`!>!`                               | [getContentCategoryList](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getContentCategoryList())`()` Returns content categories of the person entity.                              |
| [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)`!>!`                                                                                                                                 | [getDescription](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getDescription())`()` Returns the description (typically a single paragraph of text) for the person entity.         |
| [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)`!>!`                                                                                                                                 | [getEntityId](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getEntityId())`()` Returns the id of the entity.                                                                       |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Image](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Image)`!>!`                                                                                                         | [getHeaderImage](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getHeaderImage())`()` Returns the header image of the person entity.                                                |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Address](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Address)`!>!`                                                                                                     | [getLocation](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getLocation())`()` Returns the location/address of the person entity.                                                  |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Popularity](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/Popularity)`!>!`                                                                                               | [getPopularity](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getPopularity())`()` Returns the popularity for the person entity e.g. # followers, # reviews, # likes (emoji), etc. |
| `(`[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)`<`[Image](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Image)`!>!` | [getPosterImages](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getPosterImages())`()` Returns the poster image of the entity.                                                     |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Rating](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Rating)`!>!`                                                                                                       | [getRating](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getRating())`()` Returns the rating of the person entity.                                                                |
| `(`[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)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                         | [getSubtitleList](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#getSubtitleList())`()` Returns the list of subtitles for the person entity e.g. "Responds in about 3 hours", etc.  |

|                                              ### Public properties                                              |
|-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| [Profile](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/Profile)`!` | [profile](https://developer.android.com/reference/kotlin/com/google/android/engage/social/datamodel/PersonEntity#profile()) |

|                                                                                                                                                                                                                                                                                         ### Inherited functions                                                                                                                                                                                                                                                                                         |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity) |----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getEntityType](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity#getEntityType())`()` | |

## Public functions

### getActionLinkUri

```
fun getActionLinkUri(): Uri!
```

Returns the action link uri of the person entity.  

### getBadgeList

```
fun getBadgeList(): (Mutable)List<Badge!>!
```

Returns the list of badges (image/text) for the person entity e.g. "Top pro", etc.  

### getContentCategoryList

```
fun getContentCategoryList(): (Mutable)List<Int!>!
```

Returns content categories of the person entity.  

### getDescription

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

Returns the description (typically a single paragraph of text) for the person entity.  

### getEntityId

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

Returns the id of the entity.  

### getHeaderImage

```
fun getHeaderImage(): Optional<Image!>!
```

Returns the header image of the person entity.  

### getLocation

```
fun getLocation(): Optional<Address!>!
```

Returns the location/address of the person entity.  

### getPopularity

```
fun getPopularity(): Optional<Popularity!>!
```

Returns the popularity for the person entity e.g. # followers, # reviews, # likes (emoji), etc.  

### getPosterImages

```
fun getPosterImages(): (Mutable)List<Image!>!
```

Returns the poster image of the entity.  

### getRating

```
fun getRating(): Optional<Rating!>!
```

Returns the rating of the person entity.  

### getSubtitleList

```
fun getSubtitleList(): (Mutable)List<String!>!
```

Returns the list of subtitles for the person entity e.g. "Responds in about 3 hours", etc.  

## Public properties

### profile

```
val profile: Profile!
```