PointOfInterestEntity


class PointOfInterestEntity : Entity


An object representing a Point of Interest Entity.

Summary

Nested types

Builder class for PointOfInterestEntity.

@IntDef(value = [EligibleContentCategory.TYPE_EDUCATION, EligibleContentCategory.TYPE_SPORTS, EligibleContentCategory.TYPE_MOVIES_AND_TV_SHOWS, EligibleContentCategory.TYPE_TRAVEL_AND_LOCAL, EligibleContentCategory.TYPE_MEDICAL])
@Retention(value = RetentionPolicy.SOURCE)
annotation PointOfInterestEntity.EligibleContentCategory

Content category of the point of interest entity.

Public functions

Optional<AvailabilityTimeWindow!>!

Returns availability time window for the point of interest entity.

(Mutable)List<Badge!>!

Returns the list of badges (image/text) for the point of interest entity. e.g. “7 wonder of the world”, “Best trail 2024”

(Mutable)List<Int!>!

Returns content categories of the point of interest entity.

Optional<String!>!

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

Optional<String!>!

Returns the id of the entity.

Optional<Instant!>!

Returns last engagement time for the point of interest entity.

(Mutable)List<Image!>!

Returns the poster image of the entity.

Optional<Price!>!

Returns the price of the point of interest entity.

Optional<String!>!

Returns the price callout for the point of interest entity. e.g. “Limited offer"

Optional<Rating!>!

Returns the rating of the point of interest entity.

(Mutable)List<String!>!

Returns the list of subtitles for the point of interest entity. e.g. "Trail length", "Elev.

Public functions

getAvailabilityTimeWindow

fun getAvailabilityTimeWindow(): Optional<AvailabilityTimeWindow!>!

Returns availability time window for the point of interest entity.

This can refer to time the pointOfInterest entity is opened for the day/dates between which the point of interest is available.

getBadgeList

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

Returns the list of badges (image/text) for the point of interest entity. e.g. “7 wonder of the world”, “Best trail 2024”

getContentCategoryList

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

Returns content categories of the point of interest entity.

getDescription

fun getDescription(): Optional<String!>!

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

getEntityId

fun getEntityId(): Optional<String!>!

Returns the id of the entity.

getLastEngagementTime

fun getLastEngagementTime(): Optional<Instant!>!

Returns last engagement time for the point of interest entity.

Optional.

getPosterImages

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

Returns the poster image of the entity.

getPrice

fun getPrice(): Optional<Price!>!

Returns the price of the point of interest entity.

getPriceCallout

fun getPriceCallout(): Optional<String!>!

Returns the price callout for the point of interest entity. e.g. “Limited offer"

getRating

fun getRating(): Optional<Rating!>!

Returns the rating of the point of interest entity.

getSubtitleList

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

Returns the list of subtitles for the point of interest entity. e.g. "Trail length", "Elev. Gain", "Duration", "Difficulty level", “Day trips”, “Safari”, etc.

Public properties

actionLinkUri

val actionLinkUri: Uri!

displayTimeWindows

val displayTimeWindows: ImmutableList<DisplayTimeWindow!>!

location

val location: Address!

title

val title: String!