HomeCard
Base information for all card layouts.
# Base information for all card layouts. interface HomeCard { # Specifies which badge applies to the card. badge: HomeBadge# A list of buttons displayed on the card. buttons: [HomeButton!]!
# Specifies a time window that the contents of the card applies to. dateRange: FormattedString
# A message displayed when the user dismisses the card. dismissMessage: String!
# A title displayed when the user dismisses the card. dismissTitle: String!
# Specifies if this card should be considered to be featured inside of the feed theme header. featured: Boolean!
# A list of predefined messages and intents the user can select from when # sending feedback about the card. Intent can be used to pre-filter feedback # messages by their tone. feedback: [HomeCardFeedback!]!
# A list of predefined messages the user can select from when sending feedback about the card. feedbackOptions: [String!]!
# ID of the card. id: ID!
# An image displayed on the card. image( # Converts image file type from SVG to PNG, or leaves as original SVG. contentType: HomeContentType = PNG
# Image height in pixels between 1 and 2048. This argument is deprecated: Use #
maxHeight
onImage.transformedSrc
instead. maxHeight: Int# Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead. maxWidth: Int ): Image# Specifies a view template to use when rendering the card. layout: HomeCardLayout!
# A more detailed description of the card, typically containing the actual messaging to the merchant. message: FormattedString
# Specifies if this card can be voted on. showVote: Boolean!
# Specifies if this card can be pulled up into a priority container on top of the feed. spotlight: Boolean!
# Text for the header of the card. title: FormattedString! }
Possible types
-
HomeActionListCard
-
HomeBlogCard
-
HomeBookmarkCard
-
HomeComparisonCard
-
HomeContentCard
-
HomeCountdownCard
-
HomeLineGraphCard
-
HomeProgressCard
-
HomeSimpleCard
-
HomeTableCard
-
HomeVideoCard
Fields
featured
(Boolean!
)
Specifies if this card should be considered to be featured inside of the feed theme header.
feedback
([HomeCardFeedback!]!
)
A list of predefined messages and intents the user can select from when sending feedback about the card. Intent can be used to pre-filter feedback messages by their tone.
image
(Image
)
An image displayed on the card.
Argument | Type | Default | Description |
---|---|---|---|
contentType
|
HomeContentType
|
|
Converts image file type from SVG to PNG, or leaves as original SVG. |
maxHeight
|
Int
|
|
Image height in pixels between 1 and 2048. This argument is deprecated: Use |
maxWidth
|
Int
|
|
Image width in pixels between 1 and 2048. This argument is deprecated: Use |
message
(FormattedString
)
A more detailed description of the card, typically containing the actual messaging to the merchant.
spotlight
(Boolean!
)
Specifies if this card can be pulled up into a priority container on top of the feed.
Deprecated fields
feedbackOptions
([String!]!
)
deprecated
A list of predefined messages the user can select from when sending feedback about the card.
Deprecation warning
Use feedback
instead