HomeNotification

Required access

read_home access scope

Home item to display a notification.

Show definition
# Home item to display a notification.
type HomeNotification {
  # A single interactable button for the notification.
  button: HomeButton!

  # Message being displayed after dismissing the notification.
  dismissMessage: FormattedString

  # Indicates if the notification can be dismissed or not.
  dismissible: Boolean!

  # Unique identifier for use in analytics.
  handle: String!

  # Unique identifier for use in analytics.
  id: ID!

  # A more detailed description of the notification.
  message: FormattedString

  # Indicates severity of the notification for styling and grouping.
  severity: HomeNotificationSeverity!

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

Fields

button   (HomeButton!)

A single interactable button for the notification.

dismissMessage   (FormattedString)

Message being displayed after dismissing the notification.

dismissible   (Boolean!)

Indicates if the notification can be dismissed or not.

id   (ID!)

Unique identifier for use in analytics.

message   (FormattedString)

A more detailed description of the notification.

severity   (HomeNotificationSeverity!)

Indicates severity of the notification for styling and grouping.

title   (FormattedString!)

Text for the header of the notification.

Deprecated fields

Show/Hide

handle   (String!) deprecated

Unique identifier for use in analytics.

Deprecation warning

Use id instead