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

ContainersStoreInterface

interface ContainersStoreInterface

Inheritors

ContainersStore

Types

Companion

object Companion

Functions

create

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

createForPolicy

abstract fun createForPolicy(policyId: String): Container

getSiteAssociation

abstract fun getSiteAssociation(site: String): UInt

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

getSiteAssociations

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

moveContainers

abstract 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

abstract fun policyIdentities(): List<Container>

policyIdentity

abstract fun policyIdentity(policyId: String): Container?

privateIdentity

abstract fun privateIdentity(name: String): Container?

privateUserContextIds

abstract fun privateUserContextIds(): List<UInt>

publicIdentities

abstract fun publicIdentities(): List<Container>

publicIdentityFromId

abstract fun publicIdentityFromId(userContextId: UInt): Container?

publicUserContextIds

abstract fun publicUserContextIds(): List<UInt>

remove

abstract fun remove(userContextId: UInt): Container?

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

removePolicyIdentity

abstract fun removePolicyIdentity(userContextId: UInt): Container?

removeSiteAssociation

abstract fun removeSiteAssociation(site: String)

serialize

abstract fun serialize(): ByteArray

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

setSiteAssociation

abstract fun setSiteAssociation(site: String, userContextId: UInt)

unsetCallback

abstract fun unsetCallback()

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

update

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