kotlin-components-docs/mozilla.appservices.push

Package-level declarations

Types

enum BridgeType : Enum<BridgeType>

The types of supported native bridges.

DecryptResponse

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

interface Disposable

interface FfiConverter<KotlinType, FfiType>

FfiConverterBoolean

object FfiConverterBoolean : FfiConverter<Boolean, Byte>

FfiConverterByte

object FfiConverterByte : FfiConverter<Byte, Byte>

FfiConverterMapStringString

object FfiConverterMapStringString : FfiConverterRustBuffer<Map<String, String>>

FfiConverterOptionalString

object FfiConverterOptionalString : FfiConverterRustBuffer<String?>

FfiConverterOptionalTypeSubscriptionResponse

object FfiConverterOptionalTypeSubscriptionResponse : FfiConverterRustBuffer<SubscriptionResponse?>

FfiConverterOptionalULong

object FfiConverterOptionalULong : FfiConverterRustBuffer<ULong?>

FfiConverterRustBuffer

interface FfiConverterRustBuffer<KotlinType> : FfiConverter<KotlinType, RustBuffer.ByValue>

FfiConverterSequenceByte

object FfiConverterSequenceByte : FfiConverterRustBuffer<List<Byte>>

FfiConverterSequenceTypePushSubscriptionChanged

object FfiConverterSequenceTypePushSubscriptionChanged : FfiConverterRustBuffer<List<PushSubscriptionChanged>>

FfiConverterString

object FfiConverterString : FfiConverter<String, RustBuffer.ByValue>

FfiConverterTypeBridgeType

object FfiConverterTypeBridgeType : FfiConverterRustBuffer<BridgeType>

FfiConverterTypeDecryptResponse

object FfiConverterTypeDecryptResponse : FfiConverterRustBuffer<DecryptResponse>

FfiConverterTypeKeyInfo

object FfiConverterTypeKeyInfo : FfiConverterRustBuffer<KeyInfo>

FfiConverterTypePushApiError

object FfiConverterTypePushApiError : FfiConverterRustBuffer<PushApiException>

FfiConverterTypePushConfiguration

object FfiConverterTypePushConfiguration : FfiConverterRustBuffer<PushConfiguration>

FfiConverterTypePushHttpProtocol

object FfiConverterTypePushHttpProtocol : FfiConverterRustBuffer<PushHttpProtocol>

FfiConverterTypePushManager

object FfiConverterTypePushManager : FfiConverter<PushManager, <Error class: unknown class>>

FfiConverterTypePushSubscriptionChanged

object FfiConverterTypePushSubscriptionChanged : FfiConverterRustBuffer<PushSubscriptionChanged>

FfiConverterTypeSubscriptionInfo

object FfiConverterTypeSubscriptionInfo : FfiConverterRustBuffer<SubscriptionInfo>

FfiConverterTypeSubscriptionResponse

object FfiConverterTypeSubscriptionResponse : FfiConverterRustBuffer<SubscriptionResponse>

FfiConverterULong

object FfiConverterULong : FfiConverter<ULong, Long>

open class ForeignBytes

InternalException

class InternalException(message: String) : Exception

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

Key Information that can be used to encrypt payloads

object NoPointer

Used to instantiate an interface without an actual pointer, for fakes in tests, mostly.

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

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

open class RustBuffer

RustBufferByReference

class RustBufferByReference

The equivalent of the *mut RustBuffer type. Required for callbacks taking in an out pointer.

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`

interface UniffiCleaner

UniffiNullRustCallStatusErrorHandler

object UniffiNullRustCallStatusErrorHandler : UniffiRustCallStatusErrorHandler<InternalException>

UniffiRustCallStatusErrorHandler

interface UniffiRustCallStatusErrorHandler<E>

Functions

inline fun <T : Disposable?, R> T.use(block: (T) -> R): R