urbanairship-core/com.urbanairship.push/PushManager

PushManager

open class PushManager : AirshipComponent

This class is the primary interface for customizing the display and behavior of incoming push notifications.

Properties

Link copied to clipboard
@RestrictTo(value = RestrictTo.Scope.LIBRARY_GROUP)
@NonNull
val EXTRA_NOTIFICATION_ID: String = "com.urbanairship.push.NOTIFICATION_ID"
The notification ID extra contains the ID of the notification placed in the NotificationManager by the library.
Link copied to clipboard
@RestrictTo(value = RestrictTo.Scope.LIBRARY_GROUP)
@NonNull
val EXTRA_NOTIFICATION_TAG: String = "com.urbanairship.push.NOTIFICATION_TAG"
The notification tag extra contains the tag of the notification placed in the NotificationManager by the library.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Inherited properties

Link copied to clipboard
val PushManager.pushNotificationStatusFlow: StateFlow<PushNotificationStatus>

Airship notification status state flow.

Functions

Link copied to clipboard
open fun addNotificationActionButtonGroup(@NonNull id: String, @NonNull group: NotificationActionButtonGroup)
Register a notification action group under the given name.
Link copied to clipboard
open fun addNotificationActionButtonGroups(@NonNull context: Context, @XmlRes resId: Int)
Adds notification action button groups from an xml file.
Link copied to clipboard
open fun addNotificationStatusListener(@NonNull listener: PushNotificationStatusListener)
Adds an Airship push notification status listener.
Link copied to clipboard
open fun addPushListener(@NonNull listener: PushListener)
Adds a push listener.
Link copied to clipboard
open fun addPushTokenListener(@NonNull listener: PushTokenListener)
Adds a push token listener.
Link copied to clipboard
open fun areNotificationsOptedIn(): Boolean
Checks if notifications are enabled for the app and in the push manager.
Link copied to clipboard
open fun enableUserNotifications(consumer: Consumer<Boolean>)
open fun enableUserNotifications(promptFallback: PermissionPromptFallback, consumer: Consumer<Boolean>)
Enables user notifications on Airship and tries to prompt for the notification permission.
@Nullable
open fun getForegroundNotificationDisplayPredicate(): Predicate<PushMessage>
Gets the foreground notification display predicate.
Link copied to clipboard
@Nullable
open fun getLastReceivedMetadata(): String
Returns the send metadata of the last received push.
Link copied to clipboard
@Nullable
open fun getNotificationActionGroup(@Nullable id: String): NotificationActionButtonGroup
Returns the notification action group that is registered under the given name.
Link copied to clipboard
@NonNull
open fun getPushNotificationStatus(): PushNotificationStatus
Returns the current Airship push notification status.
Link copied to clipboard
@NonNull
open fun getPushProviderType(): PushProviderType
Gets the PushProviderType corresponding to the current push provider.
Link copied to clipboard
@Nullable
open fun getPushToken(): String
Gets the push token.
Link copied to clipboard
@Nullable
open fun getQuietTimeInterval(): Array<Date>
Returns the Quiet Time interval currently set by the user.
Link copied to clipboard
open fun getUserNotificationsEnabled(): Boolean
Determines whether user-facing push notifications are enabled.
Link copied to clipboard
open fun isInQuietTime(): Boolean
Determines whether we are currently in the middle of "Quiet Time".
Link copied to clipboard
open fun isOptIn(): Boolean
Returns if the application is currently opted in for push.
Link copied to clipboard
open fun isPushAvailable(): Boolean
Determines whether the app is capable of receiving push, meaning whether a FCM or ADM push token is present.
Link copied to clipboard
open fun isQuietTimeEnabled(): Boolean
Determines whether "Quiet Time" is enabled.
Link copied to clipboard
open fun isSoundEnabled(): Boolean
Determines whether sound is enabled.
Link copied to clipboard
open fun isVibrateEnabled(): Boolean
Determines whether vibration is enabled.
Link copied to clipboard
open fun removeNotificationActionButtonGroup(@NonNull id: String)
Removes the notification button group under the given name.
Link copied to clipboard
open fun removeNotificationStatusListener(@NonNull listener: PushNotificationStatusListener)
Removes an Airship push notification status listener.
Link copied to clipboard
open fun removePushListener(@NonNull listener: PushListener)
Removes a push listener.
Link copied to clipboard
open fun removePushTokenListener(@NonNull listener: PushTokenListener)
Removes a push token listener.
open fun setForegroundNotificationDisplayPredicate(@Nullable foregroundDisplayPredicate: Predicate<PushMessage>)
Sets a predicate that determines if a notification should be presented in the foreground or not.
Link copied to clipboard
open fun setQuietTimeEnabled(enabled: Boolean)
Enables or disables quiet time.
Link copied to clipboard
open fun setQuietTimeInterval(@NonNull startTime: Date, @NonNull endTime: Date)
Sets the Quiet Time interval.
Link copied to clipboard
open fun setSoundEnabled(enabled: Boolean)
Enables or disables sound.
Link copied to clipboard
open fun setUserNotificationsEnabled(enabled: Boolean)
Enables or disables user notifications.
Link copied to clipboard
open fun setVibrateEnabled(enabled: Boolean)
Enables or disables vibration.

Inherited functions

Link copied to clipboard
suspend fun PushManager.enableUserNotifications(promptFallback: PermissionPromptFallback = PermissionPromptFallback.None): Boolean

Enables user notifications on Airship and tries to prompt for the notification permission.