BinderWrapper

interface BinderWrapper

Represents a connection to the Scatterbrain API. This class should only be injected by dagger only. By default this class is created as a singleton, as there is little value of concurrent connections to Scatterbrain

Types

Companion

object Companion

Functions

authorizeIdentity

abstract suspend fun authorizeIdentity(identity: Identity, packageName: String)

Adds an ACL to an identity authorizing an app to use it.

deauthorizeIdentity

abstract suspend fun deauthorizeIdentity(identity: Identity, packageName: String)

Removes an ACL authorizing an app to use an identity.

generateIdentity

abstract suspend fun generateIdentity(name: String): Identity

generates and returns a scatterbrain identity with ACLs matching the calling application only If additional applications need access to this identity they can be assigned via the Scatterbrain app.

getIdentities

abstract suspend fun getIdentities(): List<Identity>

Gets a list of all known identities.

getIdentity

abstract suspend fun getIdentity(fingerprint: UUID): Identity?

Gets a single identity by fingerprint.

getPackages

abstract suspend fun getPackages(): List<NamePackage>

Gets a list of packages declaring a Scatterbrain compatible BroadcastReceiver.

getPermissions

abstract suspend fun getPermissions(identity: Identity): List<NamePackage>

Gets a list of ACLs associated with a given identity object.

getScatterMessages

abstract suspend fun getScatterMessages(application: String): List<ScatterMessage>

returns a list of all stored message objects for a given application requires net.ballmerlabs.scatterroutingservice.permission.

abstract suspend fun getScatterMessages(application: String, since: Date): List<ScatterMessage>

returns a list of all stored messages for a given application after a given date.

abstract suspend fun getScatterMessages(application: String, start: Date, end: Date): List<ScatterMessage>

returns a list of all stored messages for a given application between two dates.

isConnected

abstract suspend fun isConnected(): Boolean

Checks if this SDK is connected to a running Scatterbrain router

observeIdentities

abstract suspend fun observeIdentities(): Flow<List<Identity>>

returns an asynchronous flow of identities received after this function is called in real time.

observeMessages

abstract suspend fun observeMessages(application: String): Flow<List<ScatterMessage>>

returns an asynchronous flow of all messages received after this functions is called filtered by a given application identifier.

abstract fun register()

Unregisters the internal BroadcastReceiver for Scatterbrain events.

removeIdentity

abstract suspend fun removeIdentity(identity: Identity): Boolean

Deletes an identity.

rescanPeers

abstract suspend fun rescanPeers()

Attempts to reconnect to known local peers

sendMessage

abstract suspend fun sendMessage(messages: List<ScatterMessage>)

Enqueues multiple Scatterbrain messages to the datastore.

abstract suspend fun sendMessage(message: ScatterMessage)

Enqueues a Scatterbrain message to the datastore.

abstract suspend fun sendMessage(messages: List<ScatterMessage>, identity: UUID)

Enqueues a list of messages to the datastore and signs it with a given identity.

abstract suspend fun sendMessage(messages: List<ScatterMessage>, identity: Identity)

Enqueues a list of messages to the datastore and signs it with a given identity.

abstract suspend fun sendMessage(message: ScatterMessage, identity: UUID)

Enqueues a message to the datastore and signs it with a given identity.

abstract suspend fun sendMessage(message: ScatterMessage, identity: Identity)

Enqueues a message to the datastore and signs it with a given identity.

sign

abstract suspend fun sign(identity: Identity, data: ByteArray): ByteArray

Cryptographically signs data using a stored identity.

startDiscover

abstract suspend fun startDiscover()

Starts active discovery using default transport modules This function requires net.ballmerlabs.scatterroutingservice.permission.

startPassive

abstract suspend fun startPassive()

Starts passive discovery using the default radio module.

startService

abstract suspend fun startService()

Starts the scatterbrain router if stopped.

stopDiscover

abstract suspend fun stopDiscover()

Stops active discovery This function requires net.ballmerlabs.scatterroutingservice.permission.

stopPassive

abstract suspend fun stopPassive()

Stops passive discovery This function requires net.ballmerlabs.scatterroutingservice.permission.

stopService

abstract suspend fun stopService()

Stops the scatterbrain router if started.

unbindService

abstract suspend fun unbindService()

disconnects from the binder interface

unregister

abstract fun unregister()

Unregisters Scatterbrain broadcast receivers

verify

abstract suspend fun verify(identity: Identity, data: ByteArray, sig: ByteArray): Boolean

Cryptographically verifies a detached signature using a stored identity This function requires net.ballmerlabs.scatterroutingservice.permission.

Inheritors

BinderWrapperImpl