sidewalk/com.amazon.sidewalk/Sidewalk/deregister

deregister

suspend fun deregister(sidewalkId: String, factoryReset: Boolean): SidewalkResult<Unit>

Deprecated

Please use deregisterDevice(smsn, factoryReset) instead for simpler Amazon Sidewalk device management with consistent SMSN value.

Replace with

deregisterDevice(sidewalkDevice.truncatedSmsn, factoryReset)
Content copied to clipboard

Note: This method is being deprecated in the near future, please use deregisterDevice(smsn, factoryReset) instead for simpler Amazon Sidewalk device management with consistent SMSN value.

Deregister a device from the Amazon Sidewalk network.

Return

SidewalkResult.Success if the Amazon Sidewalk device is de-registered successfully; otherwise SidewalkResult.Failure with the failure cause.

Parameters

sidewalkId

A device's ID to deregister.

factoryReset

If set to true, will attempt to scan for and factory reset the device.