GoogleApi.FCM.V1.Model.Message (google_api_fcm v0.14.0)

View Source

Message to send by Firebase Cloud Messaging Service.

Attributes

  • android (type: GoogleApi.FCM.V1.Model.AndroidConfig.t, default: nil) - Input only. Android specific options for messages sent through FCM connection server.
  • apns (type: GoogleApi.FCM.V1.Model.ApnsConfig.t, default: nil) - Input only. Apple Push Notification Service specific options.
  • condition (type: String.t, default: nil) - Condition to send a message to, e.g. "'foo' in topics && 'bar' in topics".
  • data (type: map(), default: nil) - Input only. Arbitrary key/value payload, which must be UTF-8 encoded. The key should not be a reserved word ("from", "message_type", or any word starting with "google." or "gcm.notification."). When sending payloads containing only data fields to iOS devices, only normal priority ("apns-priority": "5") is allowed in ApnsConfig.
  • fcmOptions (type: GoogleApi.FCM.V1.Model.FcmOptions.t, default: nil) - Input only. Template for FCM SDK feature options to use across all platforms.
  • name (type: String.t, default: nil) - Output Only. The identifier of the message sent, in the format of projects/*/messages/{message_id}.
  • notification (type: GoogleApi.FCM.V1.Model.Notification.t, default: nil) - Input only. Basic notification template to use across all platforms.
  • token (type: String.t, default: nil) - Registration token to send a message to.
  • topic (type: String.t, default: nil) - Topic name to send a message to, e.g. "weather". Note: "/topics/" prefix should not be provided.
  • webpush (type: GoogleApi.FCM.V1.Model.WebpushConfig.t, default: nil) - Input only. Webpush protocol options.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.FCM.V1.Model.Message{
  android: GoogleApi.FCM.V1.Model.AndroidConfig.t() | nil,
  apns: GoogleApi.FCM.V1.Model.ApnsConfig.t() | nil,
  condition: String.t() | nil,
  data: map() | nil,
  fcmOptions: GoogleApi.FCM.V1.Model.FcmOptions.t() | nil,
  name: String.t() | nil,
  notification: GoogleApi.FCM.V1.Model.Notification.t() | nil,
  token: String.t() | nil,
  topic: String.t() | nil,
  webpush: GoogleApi.FCM.V1.Model.WebpushConfig.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.