kotlin-components-docs/mozilla.appservices.push/PushManagerInterface

PushManagerInterface

interface PushManagerInterface

Object representing the PushManager used to manage subscriptions

The PushManager object is the main interface provided by this crate it allow consumers to manage push subscriptions. It exposes methods that interact with the autopush server and persists state representing subscriptions.

Inheritors

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract fun decrypt(payload: Map<String, String>): DecryptResponse

Decrypts a raw push message.

Link copied to clipboard
abstract fun getSubscription(scope: String): SubscriptionResponse?

Retrieves an existing push subscription

Link copied to clipboard
abstract fun subscribe(scope: String, appServerSey: String? = null): SubscriptionResponse

Subscribes to a new channel and gets the Subscription Info block

Link copied to clipboard
abstract fun unsubscribe(scope: String): Boolean

Unsubscribe from given scope, ending that subscription for the user.

Link copied to clipboard
abstract fun unsubscribeAll()

Unsubscribe all channels for the user

Link copied to clipboard
abstract fun update(registrationToken: String)

Updates the Native OS push registration ID.

Link copied to clipboard
abstract fun verifyConnection(forceVerify: Boolean = false): List<PushSubscriptionChanged>

Verifies the connection state