kotlin-components-docs/mozilla.appservices.push

Package-level declarations

Types

BridgeType

enum BridgeType : Enum<BridgeType>

The types of supported native bridges.

DecryptResponse

data class DecryptResponse(var result: List<Byte>, var scope: String)

Disposable

interface Disposable

InternalException

class InternalException(message: String) : Exception

KeyInfo

data class KeyInfo(var auth: String, var p256dh: String)

Key Information that can be used to encrypt payloads

PushApiException

sealed class PushApiException : Exception

The main Error returned from the Push component, each variant describes a different error

PushConfiguration

data class PushConfiguration(var serverHost: String, var httpProtocol: PushHttpProtocol, var bridgeType: BridgeType, var senderId: String, var databasePath: String, var verifyConnectionRateLimiter: ULong?)

PushHttpProtocol

enum PushHttpProtocol : Enum<PushHttpProtocol>

Supported protocols for push "Https" is default, and "Http" is only supported for tests

PushManager

open class PushManager : Disposable, AutoCloseable, PushManagerInterface

Object representing the PushManager used to manage subscriptions

PushManagerInterface

interface PushManagerInterface

Object representing the PushManager used to manage subscriptions

PushSubscriptionChanged

data class PushSubscriptionChanged(var channelId: String, var scope: String)

An dictionary describing the push subscription that changed, the caller will receive a list of `PushSubscriptionChanged` when calling `PushManager::verify_connection`, one entry for each channel that the caller should resubscribe to

SubscriptionInfo

data class SubscriptionInfo(var endpoint: String, var keys: KeyInfo)

Subscription Information, the endpoint to send push messages to and the key information that can be used to encrypt payloads

SubscriptionResponse

data class SubscriptionResponse(var channelId: String, var subscriptionInfo: SubscriptionInfo)

The subscription response object returned from `PushManager::subscribe`