GoogleApi.WalletObjects.V1.Model.Message (google_api_wallet_objects v0.12.0)

View Source

A message that will be displayed with a Valuable

Attributes

  • body (type: String.t, default: nil) - The message body.
  • displayInterval (type: GoogleApi.WalletObjects.V1.Model.TimeInterval.t, default: nil) - The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided.
  • header (type: String.t, default: nil) - The message header.
  • id (type: String.t, default: nil) - The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
  • localizedBody (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the message body.
  • localizedHeader (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the message header.
  • messageType (type: String.t, default: nil) - The message type.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.WalletObjects.V1.Model.Message{
  body: String.t() | nil,
  displayInterval: GoogleApi.WalletObjects.V1.Model.TimeInterval.t() | nil,
  header: String.t() | nil,
  id: String.t() | nil,
  kind: String.t() | nil,
  localizedBody: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil,
  localizedHeader: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil,
  messageType: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.