Send a critical alert message to iOS device users

Your app is most likely to have users from different devices that run on iOS, Android, or web, which calls for the need to implement platform-specific code when it comes to sending a notification such as a critical alert. A critical alert is a notification that can be sent to iOS device users even when Mute or Do Not Disturb is turned on. Use a UserMessageCreateParams instance to properly notify critical alert messages to iOS device users in your app.

First, create an AppleCriticalAlertOptions instance and set it as an attribute of a UserMessageCreateParams instance. Then, pass the UserMessageCreateParams instance as an argument to a parameter in the sendUserMessage() method. The same applies to FileMessageCreateParams and sendFileMessage().

Note: To learn more about how to set critical alerts, visit Apple critical alerts.

// Send a critical alert user message.
val params = UserMessageCreateParams().apply {
    appleCriticalAlertOptions = AppleCriticalAlertOptions(
        "name",
        0.7
    ) // Acceptable values for volume are 0 to 1.0, inclusive.
}
channel.sendUserMessage(params) { message, e ->
    if (e != null) {
        // Handle error.
    }
}

// Send a critical alert file message.
val params = FileMessageCreateParams().apply {
    appleCriticalAlertOptions = AppleCriticalAlertOptions(
        "name",
        0.7
    ) // Acceptable values for volume are 0 to 1.0, inclusive.
}
channel.sendFileMessage(params) { message, e ->
    if (e != null) {
        // Handle error.
    }
}