kotlin-components-docs/mozilla.appservices.remotetabs

Package-level declarations

Types

data class ClientRemoteTabs(var clientId: String, var clientName: String, var deviceType: DeviceType, var lastModified: Long, var remoteTabs: List<RemoteTabRecord>, var tabGroups: Map<String, TabGroup>, var windows: Map<String, Window>)

Disposable

interface Disposable

FfiConverterTypeTabsGuid

typealias FfiConverterTypeTabsGuid = FfiConverterString

FfiConverterTypeTimestamp

typealias FfiConverterTypeTimestamp = FfiConverterLong

InternalException

class InternalException(message: String) : Exception

LocalTabsInfo

data class LocalTabsInfo(var tabs: List<RemoteTabRecord>, var tabGroups: Map<String, TabGroup>, var windows: Map<String, Window>)

PendingCommand

data class PendingCommand(var deviceId: String, var command: RemoteCommand, var timeRequested: Timestamp, var timeSent: Timestamp?)

Represents a "pending" command.

RemoteCommand

sealed class RemoteCommand

A command which should be sent to a remote device.

RemoteCommandStore

open class RemoteCommandStore : Disposable, AutoCloseable, RemoteCommandStoreInterface

RemoteCommandStoreInterface

interface RemoteCommandStoreInterface

RemoteTabRecord

data class RemoteTabRecord(var title: String, var urlHistory: List<String>, var icon: String?, var lastUsed: Long, var inactive: Boolean = false, var pinned: Boolean = false, var index: UInt, var windowId: String = "", var tabGroupId: String = "")

TabGroup

data class TabGroup(var id: String, var name: String, var color: String, var collapsed: Boolean)

A tab-group, representing a session store TabGroupStateData.

TabsApiException

sealed class TabsApiException : Exception

TabsBridgedEngine

open class TabsBridgedEngine : Disposable, AutoCloseable, TabsBridgedEngineInterface

Note the canonical docs for this are in https://searchfox.org/mozilla-central/source/services/interfaces/mozIBridgedSyncEngine.idl It's only actually used in desktop, but it's fine to expose this everywhere. NOTE: all timestamps here are milliseconds.

TabsBridgedEngineInterface

interface TabsBridgedEngineInterface

TabsGuid

typealias TabsGuid = String

Typealias from the type name used in the UDL file to the builtin type. This is needed because the UDL type name is used in function/method signatures. It's also what we have an external type that references a custom type.

TabsStore

open class TabsStore : Disposable, AutoCloseable, TabsStoreInterface

TabsStoreInterface

interface TabsStoreInterface

Timestamp

typealias Timestamp = Long

Window

data class Window(var id: String, var lastUsed: Timestamp, var index: UInt, var windowType: WindowType)

WindowType

enum WindowType : Enum<WindowType>