ShoppingEntity


class ShoppingEntity : Entity


An object representing a Shopping Entity.

Summary

Nested types

Builder class for ShoppingEntity.

Public functions

Optional<String!>!

Returns the callout for the shopping entity. e.g. "Thanksgiving deal"

Optional<String!>!

Returns the callout fine print of the shopping entity. e.g. "Limited time only"

(Mutable)List<DisplayTimeWindow!>!

Returns the display time window associated with the shopping entity.

Optional<String!>!

Returns the id of the entity.

(Mutable)List<Image!>!

Returns the poster image of the entity.

Optional<Price!>!

Returns the price of the shopping entity.

Optional<Rating!>!

Returns the rating of the shopping entity.

Optional<String!>!

Returns the title of the shopping entity.

Public properties

Uri!

Public functions

getCallout

fun getCallout(): Optional<String!>!

Returns the callout for the shopping entity. e.g. "Thanksgiving deal"

getCalloutFinePrint

fun getCalloutFinePrint(): Optional<String!>!

Returns the callout fine print of the shopping entity. e.g. "Limited time only"

getDisplayTimeWindows

fun getDisplayTimeWindows(): (Mutable)List<DisplayTimeWindow!>!

Returns the display time window associated with the shopping entity.

This can be used for several use cases like offer expiry time window, preorder availability time window.

getEntityId

fun getEntityId(): Optional<String!>!

Returns the id of the entity.

getPosterImages

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

Returns the poster image of the entity.

getPrice

fun getPrice(): Optional<Price!>!

Returns the price of the shopping entity.

getRating

fun getRating(): Optional<Rating!>!

Returns the rating of the shopping entity.

getTitle

fun getTitle(): Optional<String!>!

Returns the title of the shopping entity.

Public properties

actionLinkUri

val actionLinkUriUri!