kotlin-components-docs/mozilla.appservices.containers/ContainersStore

ContainersStore

open class ContainersStore : Disposable, AutoCloseable, ContainersStoreInterface

Constructors

constructor(bytes: ByteArray?, defaultIdentities: List<DefaultIdentity>?, callback: ContainersCallback)

Seeds the store from a stored document, or from the default identities when bytes is None. If a migration ran, the document is persisted before this returns.

Functions

@Synchronized

open override fun close()

create

open override fun create(name: String, icon: ContainerIcon, color: ContainerColor): Container

createForPolicy

open override fun createForPolicy(policyId: String): Container

destroy

open override fun destroy()

getSiteAssociation

open override fun getSiteAssociation(site: String): UInt

The container bound to site, or 0 when there is none.

getSiteAssociations

open override fun getSiteAssociations(userContextId: UInt?): List<SiteAssociation>

moveContainers

open override fun moveContainers(userContextIds: List<UInt>, position: Long): Boolean

Moves the given public containers before position, or to the end when it is -1. Positions below -1 are rejected.

policyIdentities

open override fun policyIdentities(): List<Container>

policyIdentity

open override fun policyIdentity(policyId: String): Container?

privateIdentity

open override fun privateIdentity(name: String): Container?

privateUserContextIds

open override fun privateUserContextIds(): List<UInt>

publicIdentities

open override fun publicIdentities(): List<Container>

publicIdentityFromId

open override fun publicIdentityFromId(userContextId: UInt): Container?

publicUserContextIds

open override fun publicUserContextIds(): List<UInt>

remove

open override fun remove(userContextId: UInt): Container?

Removes a public container. Clearing the data stored under its origin attributes is the embedder's job.

removePolicyIdentity

open override fun removePolicyIdentity(userContextId: UInt): Container?

removeSiteAssociation

open override fun removeSiteAssociation(site: String)

serialize

open override fun serialize(): ByteArray

The document as it stands, for the embedder to write.

setSiteAssociation

open override fun setSiteAssociation(site: String, userContextId: UInt)

unsetCallback

open override fun unsetCallback()

Drops the callback, so that a late mutation during teardown cannot reach an embedder that is already gone.

update

open override fun update(userContextId: UInt, name: String, icon: ContainerIcon, color: ContainerColor): Container?

Properties

uniffiIsDestroyed

val uniffiIsDestroyed: Boolean

Whether the current object has been destroyed and its reference is gone in the Rust side.