HomeSimpleCard

Required access

read_home access scope

A card with text, image, and one or more buttons.

Show definition
# A card with text, image, and one or more buttons.
type HomeSimpleCard implements 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 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(
    # Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.
    maxWidth: Int

    # Image height in pixels between 1 and 2048. This argument is deprecated: Use
    # `maxHeight` on `Image.transformedSrc` instead.
    maxHeight: Int

    # Converts image file type from SVG to PNG, or leaves as original SVG.
    contentType: HomeContentType = PNG
  ): Image

  # Semantic type of a Home Card image. These can be used to treat images differently in the UI.
  imageType: HomeImageType

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

  # Text for the header of the card.
  title: FormattedString!
}

Implements

Fields

badge   (HomeBadge)

Specifies which badge applies to the card.

buttons   ([HomeButton!]!)

A list of buttons displayed on the card.

dateRange   (FormattedString)

Specifies a time window that the contents of the card applies to.

dismissMessage   (String!)

A message displayed when the user dismisses the card.

dismissTitle   (String!)

A title displayed when the user dismisses the card.

Specifies if this card should be considered to be featured inside of the feed theme header.

feedbackOptions   ([String!]!)

A list of predefined messages the user can select from when sending feedback about the card.

id   (ID!)

ID of the card.

image   (Image)

An image displayed on the card.

Argument Type Default Description
contentType HomeContentType PNG

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 maxHeight on Image.transformedSrc instead.

maxWidth Int

Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

imageType   (HomeImageType)

Semantic type of a Home Card image. These can be used to treat images differently in the UI.

layout   (HomeCardLayout!)

Specifies a view template to use when rendering the card.

message   (FormattedString)

A more detailed description of the card, typically containing the actual messaging to the merchant.

showVote   (Boolean!)

Specifies if this card can be voted on.

title   (FormattedString!)

Text for the header of the card.