core-android-mock/no.nordicsemi.kotlin.ble.android.mock/MockEnvironment

MockEnvironment

sealed class MockEnvironment : MockEnvironment

A mock environment that can be used to test the behavior of the Central Manager.

Inheritors

Types

AndroidSdkVersion

class AndroidSdkVersion

Android SDK versions.

Api21

class Api21(deviceName: String = DEFAULT_NAME, isBluetoothSupported: Boolean = true, isBluetoothEnabled: Boolean = true, val isMultipleAdvertisementSupported: Boolean = true, val advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, val scanner: MockScanner = DEFAULT_MOCK_SCANNER) : MockEnvironment

A mock environment for Android 5.0 (Lollipop).

Api23

class Api23(deviceName: String = DEFAULT_NAME, isBluetoothSupported: Boolean = true, isBluetoothEnabled: Boolean = true, val isMultipleAdvertisementSupported: Boolean = true, val isLocationPermissionGranted: Boolean = true, val isLocationEnabled: Boolean = true, val advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, val scanner: MockScanner = DEFAULT_MOCK_SCANNER) : MockEnvironment

A mock environment for Android 6.0 (Marshmallow).

Api26

class Api26(deviceName: String = DEFAULT_NAME, isBluetoothSupported: Boolean = true, isBluetoothEnabled: Boolean = true, val isMultipleAdvertisementSupported: Boolean = true, val isLeExtendedAdvertisingSupported: Boolean = true, val leMaximumAdvertisingDataLength: @Range(from = 31, to = 1650) Int = if (isLeExtendedAdvertisingSupported) 1650 else 31, val isLe2MPhySupported: Boolean = true, val isLeCodedPhySupported: Boolean = true, val isScanningOnLeCodedPhySupported: Boolean = isLeCodedPhySupported, val isLocationPermissionGranted: Boolean = true, val isLocationEnabled: Boolean = true, val advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, val scanner: MockScanner = DEFAULT_MOCK_SCANNER) : MockEnvironment

A mock environment for Android 8.0 (Oreo).

Api31

class Api31(deviceName: String = DEFAULT_NAME, isBluetoothSupported: Boolean = true, isBluetoothEnabled: Boolean = true, val isMultipleAdvertisementSupported: Boolean = true, val isLeExtendedAdvertisingSupported: Boolean = true, val leMaximumAdvertisingDataLength: @Range(from = 31, to = 1650) Int = if (isLeExtendedAdvertisingSupported) 1650 else 31, val isLe2MPhySupported: Boolean = true, val isLeCodedPhySupported: Boolean = true, val isScanningOnLeCodedPhySupported: Boolean = isLeCodedPhySupported, val isBluetoothScanPermissionGranted: Boolean = true, val isBluetoothConnectPermissionGranted: Boolean = true, val isBluetoothAdvertisePermissionGranted: Boolean = true, isNeverForLocationFlagSet: Boolean = true, val isLocationPermissionGranted: Boolean = true, val isLocationEnabled: Boolean = true, val advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, val scanner: MockScanner = DEFAULT_MOCK_SCANNER) : MockEnvironment

A mock environment for Android 12 (S).

Properties

advertiser

val advertiser: MockAdvertiser

A callback that will be called when the app requests to advertise. The callback should return the TX power level used for mock advertising.

androidSdkVersion

val androidSdkVersion: Int

The Android SDK version.

deviceName

var deviceName: String

isBluetoothAdvertisePermissionGranted

val isBluetoothAdvertisePermissionGranted: Boolean = false

Whether the BLUETOOTH_ADVERTISE permission is granted.

isBluetoothConnectPermissionGranted

val isBluetoothConnectPermissionGranted: Boolean = false

Whether the BLUETOOTH_CONNECT permission is granted.

isBluetoothEnabled

val isBluetoothEnabled: Boolean

isBluetoothScanPermissionGranted

val isBluetoothScanPermissionGranted: Boolean = false

Whether the BLUETOOTH_SCAN permission is granted.

isBluetoothSupported

val isBluetoothSupported: Boolean

isLe2MPhySupported

val isLe2MPhySupported: Boolean = false

Whether LE 2M PHY is supported on the device.

isLeCodedPhySupported

val isLeCodedPhySupported: Boolean = false

Whether LE Coded PHY is supported on the device.

isLeExtendedAdvertisingSupported

val isLeExtendedAdvertisingSupported: Boolean = false

Whether LE Extended Advertising feature is supported.

isLocationEnabled

val isLocationEnabled: Boolean = false

Whether location service is enabled on the device.

isLocationPermissionGranted

val isLocationPermissionGranted: Boolean = false

Whether the fine location permission is granted.

isLocationRequiredForScanning

val isLocationRequiredForScanning: Boolean = false

Whether location is required to scan for Bluetooth devices.

isMultipleAdvertisementSupported

val isMultipleAdvertisementSupported: Boolean

Whether multi advertisement is supported by the chipset.

isScanningOnLeCodedPhySupported

val isScanningOnLeCodedPhySupported: Boolean

Whether the device can scan for Bluetooth LE devices advertising on LE Coded PHY as Primary PHY.

leMaximumAdvertisingDataLength

val leMaximumAdvertisingDataLength: @Range(from = 31, to = 1650) Int = 31

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

requiresBluetoothRuntimePermissions

val requiresBluetoothRuntimePermissions: Boolean

Whether the device requires runtime permissions to use Bluetooth.

scanner

val scanner: MockScanner

A callback that will be called when the mock central manager requests to scan for devices. It returns whether the scan was successful, secretly failed, or returned an error.