AppleCriticalAlertOptions

@objc(SBDAppleCriticalAlertOptions)
public class AppleCriticalAlertOptions : NSObject, Codable

Represents the options for the Apple Critical Alert.

The BaseMessageCreateParams object may have the AppleCriticalAlertOptions object as an appleCriticalAlertOptions property. When the message that has this options is received by the iOS device, the message is displayed as a critical alert. See the Generating a Remote Notification for the details.

Since

3.0.221

  • The name of a sound file in the iOS app. The default value is default.

    Since

    3.0.221

    Declaration

    Swift

    @objc
public var name: String

  • The volume for the critical alert’s sound. Set this to a value between 0.0 (silent) and 1.0 (full volume). The default value is 1.0.

    Since

    3.0.221

    Declaration

    Swift

    @objc
public var volume: Float

  • Undocumented

    Declaration

    Swift

    @objc
public init(name: String = "default", volume: Float = 1.0)

  • Encodes this object.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws

    Parameters

    encoder

    Encoder instance