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

View Source

Apple Push Notification Service specific options.

Attributes

  • fcmOptions (type: GoogleApi.FCM.V1.Model.ApnsFcmOptions.t, default: nil) - Options for features provided by the FCM SDK for iOS.
  • headers (type: map(), default: nil) - HTTP request headers defined in Apple Push Notification Service. Refer to APNs request headers for supported headers such as apns-expiration and apns-priority. The backend sets a default value for apns-expiration of 30 days and a default value for apns-priority of 10 if not explicitly set.
  • liveActivityToken (type: String.t, default: nil) - Optional. Apple Live Activity token to send updates to. This token can either be a push token or push-to-start token from Apple. To start, update, or end a live activity remotely using FCM, construct an aps payload and put it in the apns.payload field.
  • payload (type: map(), default: nil) - APNs payload as a JSON object, including both aps dictionary and custom payload. See Payload Key Reference. If present, it overrides google.firebase.fcm.v1.Notification.title and google.firebase.fcm.v1.Notification.body.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.FCM.V1.Model.ApnsConfig{
  fcmOptions: GoogleApi.FCM.V1.Model.ApnsFcmOptions.t() | nil,
  headers: map() | nil,
  liveActivityToken: String.t() | nil,
  payload: map() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.