kotlin-components-docs/mozilla.appservices.remotetabs/RemoteCommandStoreInterface

RemoteCommandStoreInterface

interface RemoteCommandStoreInterface

Inheritors

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract fun addRemoteCommand(deviceId: String, command: RemoteCommand): Boolean

Add a new command, after which it will be pending. Returns false if the command is already active.

Link copied to clipboard
abstract fun addRemoteCommandAt(deviceId: String, command: RemoteCommand, when: Timestamp): Boolean

Add a new command with an explicit timestamp. Primarily used by tests.

Link copied to clipboard
abstract fun getUnsentCommands(): List<PendingCommand>

Return all unsent commands. This is for the code sending the commands, result is sorted by time_requested.

Link copied to clipboard
abstract fun removeRemoteCommand(deviceId: String, command: RemoteCommand): Boolean

Removes the remote command. Typically used to implement "undo" but may also be used by the queue processor when it gives up trying to send a command.

Link copied to clipboard
abstract fun setPendingCommandSent(command: PendingCommand): Boolean

Flag a command as sent.