kmpnotifier-core/com.mmk.kmpnotifier/KMPNotifier

KMPNotifier

Main entry point of the KMPNotifier library.

Initialize it once on application start, passing the platform configuration and the capabilities (extensions) you want to use:

// Local notifications only:
KMPNotifier.initialize(configuration, LocalNotifications)

// Local + Firebase push (android/ios, requires kmpnotifier-push-firebase):
KMPNotifier.initialize(configuration, FirebasePush)

Local notifications are then available through KMPNotifier.localNotifier (or LocalNotifications.notifier), and push through KMPNotifier.firebasePushNotifier (or FirebasePush.notifier).

Types

Listener

interface Listener

Shared notification events, fired for both local and push notifications.

Properties

isInitialized

val isInitialized: Boolean

Whether initialize has been called.

permissionUtil

val permissionUtil: PermissionUtil

Permission util to check and ask notification permission. On Android, runtime permission must be requested in an Activity — see ComponentActivity.permissionUtil().

Functions

addListener

fun addListener(listener: KMPNotifier.Listener)

Adds a listener for shared notification events.

initialize

fun initialize(configuration: NotificationPlatformConfiguration, extensions: List<KMPNotifierExtension>)

Initializes the library. Call on application start.

@HiddenFromObjC

fun initialize(configuration: NotificationPlatformConfiguration, vararg extensions: KMPNotifierExtension)

Initializes the library. Call on application start. On iOS call it from the main thread (e.g. in didFinishLaunchingWithOptions) — the notification-center delegate is installed during initialization. Calling it again is a no-op for the configuration; extensions not yet installed are still installed.

initialize

fun KMPNotifier.initialize(context: Context, configuration: NotificationPlatformConfiguration, vararg extensions: KMPNotifierExtension)

onCreateOrOnNewIntent

fun KMPNotifier.onCreateOrOnNewIntent(intent: Intent?)

In order to receive notification data payload this function needs to be called in Android side in launcher Activity #onCreate and #onNewIntent methods.

onNotificationClicked

fun KMPNotifier.onNotificationClicked(notificationContent: UNNotificationContent)

Emits the notification-clicked event for the given notification content.

removeListener

fun removeListener(listener: KMPNotifier.Listener)

Removes a previously added listener.

setListener

fun setListener(listener: KMPNotifier.Listener?)

Replaces all listeners with the given one. Pass null to remove all listeners.

setLogger

fun setLogger(logger: Logger)

Sets a logger for the library's internal logs. By default nothing is logged.