Models

BluetoothAdapterStateCopy Anchor Link

enum BluetoothAdapterState

The state of the device's Bluetooth adapter.

ValuesCopy Anchor Link

BluetoothAdapterState.unknownCopy Anchor Link

static const BluetoothAdapterState unknown

The platform has not reported its adapter state yet.

BluetoothAdapterState.onCopy Anchor Link

static const BluetoothAdapterState on

Bluetooth is ready for use.

BluetoothAdapterState.offCopy Anchor Link

static const BluetoothAdapterState off

Bluetooth is turned off.

BluetoothAdapterState.unauthorizedCopy Anchor Link

static const BluetoothAdapterState unauthorized

The app is not authorized to use Bluetooth.

BluetoothAdapterState.unsupportedCopy Anchor Link

static const BluetoothAdapterState unsupported

This device does not support Bluetooth LE.

BluetoothAdvertisementCopy Anchor Link

class BluetoothAdvertisement

What a peripheral advertised during scanning.

ConstructorsCopy Anchor Link

BluetoothAdvertisement.newCopy Anchor Link

BluetoothAdvertisement({
  required String name,
  required Iterable<String> serviceUuids,
  String? manufacturerData,
})

Creates an advertisement snapshot.

PropertiesCopy Anchor Link

BluetoothAdvertisement.nameCopy Anchor Link

final String name

The advertised name, or an empty string when unavailable.

BluetoothAdvertisement.serviceUuidsCopy Anchor Link

final List<String> serviceUuids

The advertised service UUIDs.

BluetoothAdvertisement.manufacturerDataCopy Anchor Link

final String? manufacturerData

The base64 encoded manufacturer data, or null when absent.

BluetoothConnectionStateCopy Anchor Link

enum BluetoothConnectionState

The state of a supported nearby device.

ValuesCopy Anchor Link

BluetoothConnectionState.idleCopy Anchor Link

static const BluetoothConnectionState idle

The device has not started connecting.

BluetoothConnectionState.connectingCopy Anchor Link

static const BluetoothConnectionState connecting

The runtime is opening the device connection.

BluetoothConnectionState.connectedCopy Anchor Link

static const BluetoothConnectionState connected

The device connection is open.

BluetoothConnectionState.measuringCopy Anchor Link

static const BluetoothConnectionState measuring

The device is sending measurements.

BluetoothConnectionState.disconnectedCopy Anchor Link

static const BluetoothConnectionState disconnected

The device connection is closed.

BluetoothConnectionState.failedCopy Anchor Link

static const BluetoothConnectionState failed

The device connection failed.

BluetoothDeviceReadingCopy Anchor Link

class BluetoothDeviceReading

A measurement reported by a supported Bluetooth device.

ConstructorsCopy Anchor Link

BluetoothDeviceReading.newCopy Anchor Link

BluetoothDeviceReading({
  required String id,
  required BluetoothReadingDevice device,
  required JsonMap measurement,
  required DateTime receivedAt,
  required BluetoothSaveState save,
})

Creates a device reading snapshot.

PropertiesCopy Anchor Link

BluetoothDeviceReading.idCopy Anchor Link

final String id

A reading ID; timestamped readings use the same ID when resent.

BluetoothDeviceReading.deviceCopy Anchor Link

final BluetoothReadingDevice device

The device that produced the reading.

BluetoothDeviceReading.measurementCopy Anchor Link

final JsonMap measurement

The decoded Ovok measurement.

BluetoothDeviceReading.receivedAtCopy Anchor Link

final DateTime receivedAt

When this app received the reading.

BluetoothDeviceReading.saveCopy Anchor Link

final BluetoothSaveState save

Whether the measurement was saved.

MethodsCopy Anchor Link

BluetoothDeviceReading.copyWithCopy Anchor Link

BluetoothDeviceReading copyWith({required BluetoothSaveState save})

Returns a copy with the supplied save state.

Returns BluetoothDeviceReading.

BluetoothNearbyDeviceCopy Anchor Link

class BluetoothNearbyDevice

A supported peripheral discovered by a scan.

ConstructorsCopy Anchor Link

BluetoothNearbyDevice.newCopy Anchor Link

BluetoothNearbyDevice({
  required String id,
  required String key,
  required String name,
  required BluetoothConnectionState connection,
  BluetoothError? error,
})

Creates a nearby device snapshot.

PropertiesCopy Anchor Link

BluetoothNearbyDevice.idCopy Anchor Link

final String id

The platform identifier for the peripheral.

BluetoothNearbyDevice.keyCopy Anchor Link

final String key

The device key reported with its readings.

BluetoothNearbyDevice.nameCopy Anchor Link

final String name

The name from its advertisement.

BluetoothNearbyDevice.connectionCopy Anchor Link

final BluetoothConnectionState connection

The current connection state.

BluetoothNearbyDevice.errorCopy Anchor Link

final BluetoothError? error

The last connection error, when one occurred.

MethodsCopy Anchor Link

BluetoothNearbyDevice.copyWithCopy Anchor Link

BluetoothNearbyDevice copyWith({
  String? name,
  BluetoothConnectionState? connection,
  BluetoothError? error,
  bool clearError = false,
})

Returns a copy with the supplied fields changed.

Returns BluetoothNearbyDevice.

BluetoothPermissionCopy Anchor Link

enum BluetoothPermission

The app's Bluetooth permission state.

ValuesCopy Anchor Link

BluetoothPermission.unknownCopy Anchor Link

static const BluetoothPermission unknown

The runtime has not checked permission yet.

BluetoothPermission.grantedCopy Anchor Link

static const BluetoothPermission granted

Bluetooth access is permitted.

BluetoothPermission.deniedCopy Anchor Link

static const BluetoothPermission denied

The user can still be asked for access.

BluetoothPermission.blockedCopy Anchor Link

static const BluetoothPermission blocked

Only system settings can grant access.

BluetoothReadingDeviceCopy Anchor Link

class BluetoothReadingDevice

The identity of the device that produced a reading.

ConstructorsCopy Anchor Link

BluetoothReadingDevice.newCopy Anchor Link

BluetoothReadingDevice({
  required String id,
  required String key,
  required String name,
})

Creates a device identity for a reading.

PropertiesCopy Anchor Link

BluetoothReadingDevice.idCopy Anchor Link

final String id

The platform identifier for the peripheral.

BluetoothReadingDevice.keyCopy Anchor Link

final String key

The device key reported with its readings.

BluetoothReadingDevice.nameCopy Anchor Link

final String name

The name from its advertisement.

BluetoothSaveStateCopy Anchor Link

class BluetoothSaveState

The outcome of saving a device reading.

ConstructorsCopy Anchor Link

BluetoothSaveState.savingCopy Anchor Link

BluetoothSaveState.saving()

Creates a reading that is waiting for a save result.

BluetoothSaveState.savedCopy Anchor Link

BluetoothSaveState.saved()

Creates a reading that was saved.

BluetoothSaveState.queuedCopy Anchor Link

BluetoothSaveState.queued(String queueId)

Creates a reading queued for an offline retry.

BluetoothSaveState.failedCopy Anchor Link

BluetoothSaveState.failed(BluetoothError error)

Creates a reading whose save failed and can be retried.

PropertiesCopy Anchor Link

BluetoothSaveState.statusCopy Anchor Link

final BluetoothSaveStatus status

The save state.

BluetoothSaveState.queueIdCopy Anchor Link

final String? queueId

The offline queue ID when status is queued.

BluetoothSaveState.errorCopy Anchor Link

final BluetoothError? error

The failure when status is failed.

BluetoothSaveStatusCopy Anchor Link

enum BluetoothSaveStatus

Whether a device reading was saved or needs another attempt.

ValuesCopy Anchor Link

BluetoothSaveStatus.savingCopy Anchor Link

static const BluetoothSaveStatus saving

The sink has not answered yet.

BluetoothSaveStatus.savedCopy Anchor Link

static const BluetoothSaveStatus saved

The sink saved the reading.

BluetoothSaveStatus.queuedCopy Anchor Link

static const BluetoothSaveStatus queued

The sink queued the reading for a later retry.

BluetoothSaveStatus.failedCopy Anchor Link

static const BluetoothSaveStatus failed

The sink could not save or queue the reading.

BluetoothSnapshotCopy Anchor Link

class BluetoothSnapshot

A consistent view of the Bluetooth runtime's current state.

ConstructorsCopy Anchor Link

BluetoothSnapshot.newCopy Anchor Link

BluetoothSnapshot({
  required BluetoothAdapterState adapter,
  required BluetoothPermission permission,
  required bool scanning,
  required BluetoothError? scanError,
  required Iterable<BluetoothNearbyDevice> devices,
  required Iterable<String> paired,
  required Iterable<BluetoothDeviceReading> readings,
})

Creates an immutable runtime snapshot.

PropertiesCopy Anchor Link

BluetoothSnapshot.adapterCopy Anchor Link

final BluetoothAdapterState adapter

The current Bluetooth adapter state.

BluetoothSnapshot.permissionCopy Anchor Link

final BluetoothPermission permission

The last observed Bluetooth permission state.

BluetoothSnapshot.scanningCopy Anchor Link

final bool scanning

Whether scanning has been requested.

BluetoothSnapshot.scanErrorCopy Anchor Link

final BluetoothError? scanError

The last scan error, when one occurred.

BluetoothSnapshot.devicesCopy Anchor Link

final List<BluetoothNearbyDevice> devices

Supported peripherals, in discovery order.

BluetoothSnapshot.pairedCopy Anchor Link

final List<String> paired

Paired device IDs.

BluetoothSnapshot.readingsCopy Anchor Link

final List<BluetoothDeviceReading> readings

Recent readings, oldest first.

MethodsCopy Anchor Link

BluetoothSnapshot.deviceCopy Anchor Link

BluetoothNearbyDevice? device(String id)

Finds a nearby device by id.

Returns BluetoothNearbyDevice?.

BluetoothSnapshot.copyWithCopy Anchor Link

BluetoothSnapshot copyWith({
  BluetoothAdapterState? adapter,
  BluetoothPermission? permission,
  bool? scanning,
  BluetoothError? scanError,
  bool clearScanError = false,
  Iterable<BluetoothNearbyDevice>? devices,
  Iterable<String>? paired,
  Iterable<BluetoothDeviceReading>? readings,
})

Returns a new snapshot with selected fields replaced.

Returns BluetoothSnapshot.