Class: Firebase::Admin::Messaging::APNSFCMOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/firebase/admin/messaging/apns_fcm_options.rb

Overview

Options for features provided by the FCM SDK for iOS.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(analytics_label: nil, image: nil) ⇒ APNSFCMOptions

Initializes an Firebase::Admin::Messaging::APNSFCMOptions.

Parameters:

  • analytics_label (String, nil) (defaults to: nil) —

    The label associated with the message’s analytics data (optional).

  • image (String, nil) (defaults to: nil) —

    URL of an image to be displayed in the notification (optional).



20
21
22
23
 
# File 'lib/firebase/admin/messaging/apns_fcm_options.rb', line 20

def initialize(analytics_label: nil, image: nil)
  self.analytics_label = analytics_label
  self.image = image
end

Instance Attribute Details

#analytics_label ⇒ String?

Returns The label associated with the message’s analytics data.

Returns:

  • (String, nil) —

    The label associated with the message’s analytics data.



8
9
10
 
# File 'lib/firebase/admin/messaging/apns_fcm_options.rb', line 8

def analytics_label
  @analytics_label
end

#image ⇒ String?

Returns URL of an image to be displayed in the notification.

Returns:

  • (String, nil) —

    URL of an image to be displayed in the notification.



12
13
14
 
# File 'lib/firebase/admin/messaging/apns_fcm_options.rb', line 12

def image
  @image
end