sidewalk/com.amazon.sidewalk/Sidewalk

Sidewalk

class Sidewalk(context: Context, authProvider: SidewalkAuthProvider, deregisterStrategy: DeregisterStrategy = DeregisterStrategy.DEFAULT)

Main entry point to the Sidewalk Mobile SDK.

Parameters

context

Android context

authProvider

Authentication token provider

deregisterStrategy

Configurable parameters for de-registration flow

Constructors

Link copied to clipboard
fun Sidewalk(context: Context, authProvider: SidewalkAuthProvider, deregisterStrategy: DeregisterStrategy = DeregisterStrategy.DEFAULT)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
suspend fun clearAccountCache(): SidewalkResult<Unit>

Clear user related data, this method should be called explicitly by host app when the account credential is no longer available, like user logged out.

Link copied to clipboard
suspend fun deregister(sidewalkId: String, factoryReset: Boolean): SidewalkResult<Unit>

Deregister a device from Sidewalk network.

Link copied to clipboard
fun register(sidewalkConnection: SidewalkConnection): Flow<RegisterResult>

Register a device with the Sidewalk backend through the BLE secure connection.

fun register(descriptor: SidewalkDeviceDescriptor): Flow<RegisterResult>

Register a device with the Sidewalk backend. If a SidewalkConnection has been established with the device before registration, use register(SidewalkConnection) instead.

suspend fun remoteCertificateProvisioningAuthenticate(request: CertificateSigningRequest): AuthenticateRemoteDeviceResult

Authenticate existing devices already in the field onto Sidewalk network.

Link copied to clipboard
fun scan(): Flow<SidewalkResult<SidewalkDevice>>

Starts scanning for Sidewalk devices via Bluetooth.

Link copied to clipboard
suspend fun secureConnect(descriptor: SidewalkDeviceDescriptor): SidewalkResult<SidewalkConnection>

Securely connects to a given Sidewalk device.