HomeActionRow

Required access

read_home access scope

Holds the contents of an individual row in an action list card.

Show definition
# Holds the contents of an individual row in an action list card.
type HomeActionRow {
  # A button that launches the action associated with the row.
  button: HomeButton!

  # A more detailed description of the row, typically containing the actual messaging to the merchant.
  description: String!

  # An image displayed in the row.
  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

  # A label displayed on the row.
  label: String!
}

Fields

button   (HomeButton!)

A button that launches the action associated with the row.

Required access

read_ access scope

description   (String!)

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

Required access

read_ access scope

image   (Image)

An image displayed in the row.

Required access

read_ access scope

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.

label   (String!)

A label displayed on the row.

Required access

read_ access scope

Sign up for a Partner account to get started.

Sign up