core-android/no.nordicsemi.kotlin.ble.core.android.preview/PreviewEnvironment

PreviewEnvironment

class PreviewEnvironment(val androidSdkVersion: Int = AndroidEnvironment.SdkVersion.LATEST, val deviceName: String = "Stub", bluetoothState: Manager.State = Manager.State.POWERED_ON, val locationState: StateFlow<Boolean> = MutableStateFlow(true), val isBluetoothSupported: Boolean = true, val isLocationRequiredForScanning: Boolean = false, val isLocationPermissionGranted: Boolean = false, val isLe2MPhySupported: Boolean = true, val isLeCodedPhySupported: Boolean = true, val isScanningOnLeCodedPhySupported: Boolean = true, val isBluetoothScanPermissionGranted: Boolean = true, val isBluetoothConnectPermissionGranted: Boolean = true, val isBluetoothAdvertisePermissionGranted: Boolean = true, val isBluetoothPrivilegedPermissionGranted: Boolean = false, val isMultipleAdvertisementSupported: Boolean = true, val isLeExtendedAdvertisingSupported: Boolean = true, val isLePeriodicAdvertisingSupported: Boolean = true, val leMaximumAdvertisingDataLength: Int = 1650) : AndroidEnvironment

A stub implementation of AndroidEnvironment for Android.

This can be used for showing @Preview in the Compose UI.

Constructors

PreviewEnvironment

constructor(androidSdkVersion: Int = AndroidEnvironment.SdkVersion.LATEST, deviceName: String = "Stub", bluetoothState: Manager.State = Manager.State.POWERED_ON, locationState: StateFlow<Boolean> = MutableStateFlow(true), isBluetoothSupported: Boolean = true, isLocationRequiredForScanning: Boolean = false, isLocationPermissionGranted: Boolean = false, isLe2MPhySupported: Boolean = true, isLeCodedPhySupported: Boolean = true, isScanningOnLeCodedPhySupported: Boolean = true, isBluetoothScanPermissionGranted: Boolean = true, isBluetoothConnectPermissionGranted: Boolean = true, isBluetoothAdvertisePermissionGranted: Boolean = true, isBluetoothPrivilegedPermissionGranted: Boolean = false, isMultipleAdvertisementSupported: Boolean = true, isLeExtendedAdvertisingSupported: Boolean = true, isLePeriodicAdvertisingSupported: Boolean = true, leMaximumAdvertisingDataLength: Int = 1650)

Properties

allowsBondRemoval

open override val allowsBondRemoval: Boolean

androidSdkVersion

open override val androidSdkVersion: Int

The Android SDK version.

automaticallyRequestsMtu

open override val automaticallyRequestsMtu: Boolean

bluetoothState

open override val bluetoothState: StateFlow<Manager.State>

A flow emitting the current Bluetooth state.

deviceName

open override val deviceName: String

deviceNameOrNull

open val deviceNameOrNull: String?

The local Bluetooth adapter name, or null if the required permission is not granted.

isBluetoothAdvertisePermissionGranted

open override val isBluetoothAdvertisePermissionGranted: Boolean

Whether the BLUETOOTH_ADVERTISE permission is granted.

isBluetoothConnectPermissionGranted

open override val isBluetoothConnectPermissionGranted: Boolean

Whether the BLUETOOTH_CONNECT permission is granted.

isBluetoothEnabled

open override val isBluetoothEnabled: Boolean

isBluetoothPrivilegedPermissionGranted

open override val isBluetoothPrivilegedPermissionGranted: Boolean

Whether BLUETOOTH_PRIVILEGED permission is granted. This permission cannot be granted to 3-rd party apps.

isBluetoothScanPermissionGranted

open override val isBluetoothScanPermissionGranted: Boolean

Whether the BLUETOOTH_SCAN permission is granted.

isBluetoothSupported

open override val isBluetoothSupported: Boolean

isLe2MPhySupported

open override val isLe2MPhySupported: Boolean

Whether LE 2M PHY is supported on the device.

isLeCodedPhySupported

open override val isLeCodedPhySupported: Boolean

Whether LE Coded PHY is supported on the device.

isLeExtendedAdvertisingSupported

open override val isLeExtendedAdvertisingSupported: Boolean

Whether LE Extended Advertising feature is supported.

isLePeriodicAdvertisingSupported

open override val isLePeriodicAdvertisingSupported: Boolean

Whether LE Periodic Advertising feature is supported.

isLocationEnabled

open val isLocationEnabled: Boolean

Whether location service is enabled on the device.

isLocationPermissionGranted

open override val isLocationPermissionGranted: Boolean

Whether the ACCESS_FINE_LOCATION permission is granted.

isLocationRequiredForScanning

open override val isLocationRequiredForScanning: Boolean

Whether location is required to scan for Bluetooth LE devices.

isMultipleAdvertisementSupported

open override val isMultipleAdvertisementSupported: Boolean

Whether multi advertisement is supported by the chipset.

isScanningOnLeCodedPhySupported

open override val isScanningOnLeCodedPhySupported: Boolean

isSystem

open override val isSystem: Boolean

leMaximumAdvertisingDataLength

open override val leMaximumAdvertisingDataLength: Int

The maximum LE advertising data length in bytes, if LE Extended Advertising feature is supported.

locationState

open override val locationState: StateFlow<Boolean>

A flow emitting the state of the location service, true when enabled, false otherwise. Location service is required to scan for Bluetooth LE beacons when isLocationRequiredForScanning is true.

reportsConnectableFlag

open override val reportsConnectableFlag: Boolean

reportsConnectionParameters

open override val reportsConnectionParameters: Boolean

requiresBluetoothRuntimePermissions

open val requiresBluetoothRuntimePermissions: Boolean

Whether the device requires runtime permissions to use Bluetooth.

supportsRuntimePermissions

open val supportsRuntimePermissions: Boolean

Whether the device supports runtime permissions.

Functions

open override fun close()

Unregisters the broadcast receiver that listens for Bluetooth state changes.

enableBluetooth

open override fun enableBluetooth()

Sends an intent to enable Bluetooth adapter on the device.