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

PushManager

open class PushManager : Disposable, AutoCloseable, 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.

Constructors

constructor(pointer: <Error class: unknown class>)

constructor(noPointer: NoPointer)

This constructor can be used to instantiate a fake object. Only used for tests. Any attempt to actually use an object constructed this way will fail as there is no connected Rust object.

constructor(config: PushConfiguration)

Creates a new `PushManager` object, not subscribed to any channels

Types

object Companion

Functions

open override fun close()

open override fun decrypt(payload: Map<String, String>): DecryptResponse

Decrypts a raw push message.

open override fun destroy()

getSubscription

open override fun getSubscription(scope: String): SubscriptionResponse?

Retrieves an existing push subscription

open override fun subscribe(scope: String, appServerSey: String?): SubscriptionResponse

Subscribes to a new channel and gets the Subscription Info block

uniffiClonePointer

fun uniffiClonePointer(): <Error class: unknown class>

open override fun unsubscribe(scope: String): Boolean

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

open override fun unsubscribeAll()

Unsubscribe all channels for the user

open override fun update(registrationToken: String)

Updates the Native OS push registration ID.

verifyConnection

open override fun verifyConnection(forceVerify: Boolean): List<PushSubscriptionChanged>

Verifies the connection state