class Firebase::Admin::Messaging::CriticalSound
Critical alert sound configuration that can be included in an {APS}
Attributes
critical[RW]
@return [Boolean, nil]
The critical alert flag. Set to `true` to enable the critical alert.
name[RW]
@return [String]
The name of a sound file in the app's main bundle or in the `Library/Sounds` folder of the app's container directory. Specify the string "default" to play the system sound.
volume[RW]
@return [Float, nil]
The volume for the critical alert's sound. Must be a value between 0.0 (silent) and 1.0 (full volume).
Public Class Methods
new(name: "default", critical: nil, volume: nil)
click to toggle source
Initializes a {CriticalSound}.
@param [String] name
The name of a sound file in the app's main bundle or in the `Library/Sounds` folder of teh app's container directory.
@param [Boolean, nil] critical
The critical alert flag (optional).
@param [Float, nil] volume
The volume for the critical alert's sound (optional). Must be a value between 0.0 (silent) and 1.0 (full volume).
# File lib/firebase/admin/messaging/critical_sound.rb, line 29 def initialize(name: "default", critical: nil, volume: nil) self.name = name self.critical = critical self.volume = volume end