class Firebase::Admin::Messaging::APS
Aps dictionary to be included in an APNS payload.
Attributes
alert[RW]
@return [APSAlert, String, nil]
Alert to be included in the message.
badge[RW]
@return [Integer, nil]
Badge to be displayed with the message. Set to 0 to remove the badge. When not specified, the badge will remain unchanged.
category[RW]
@return [String, nil]
Type of the notification.
content_available[RW]
@return [Boolean, nil]
Specifies whether to configure a background update notification.
custom_data[RW]
@return [Hash]
App-specific custom fields.
mutable_content[RW]
@return [Boolean, nil]
Specifies whether to set the `mutable-content` property on the message so the clients can modify the notification via app extensions.
sound[RW]
@return [String, CriticalSound
, nil]
Sound to be played with the message.
thread_id[RW]
@return [String, nil]
An app-specific identifier for grouping notifications.
Public Class Methods
new( alert: nil, badge: nil, sound: nil, content_available: nil, mutable_content: nil, category: nil, thread_id: nil, custom_data: nil )
click to toggle source
Initializes an {APS}.
@param [APSAlert, String, nil] alert
Alert to be included in the message (optional).
@param [Integer, nil] badge
Badge to be displayed with the message (optional). Set to 0 to remove the badge. When not specified, the badge will remain unchanged.
@param [String, CriticalSound
, nil] sound
Sound to be played with the message (optional).
@param [Boolean, nil] content_available
Specifies whether to configure a background update notification (optional).
@param [Boolean, nil] mutable_content
Specifies whether to set the `mutable-content` property on the message so the clients can modify the notification via app extensions (optional).
@param [String, nil] category
Type of the notification (optional).
@param [String, nil] thread_id
An app-specific identifier for grouping notifications (optional).
@param [Hash, nil] custom_data
App-specific custom fields (optional).
# File lib/firebase/admin/messaging/aps.rb, line 60 def initialize( alert: nil, badge: nil, sound: nil, content_available: nil, mutable_content: nil, category: nil, thread_id: nil, custom_data: nil ) self.alert = alert self.badge = badge self.sound = sound self.content_available = content_available self.mutable_content = mutable_content self.category = category self.thread_id = thread_id self.custom_data = custom_data end