Class DotNetCoreBluetoothScanner

Namespace

Bluetooth.Maui.Platforms.DotNetCore.Scanning

Assembly

Bluetooth.Maui.Platforms.DotNetCore.dll

Interface for managing and scanning Bluetooth devices.

public class DotNetCoreBluetoothScanner : BaseBluetoothScanner, INotifyPropertyChanged, IBluetoothScanner, IAsyncDisposable

Inheritance

object

BaseBindableObject

BaseBluetoothScanner

DotNetCoreBluetoothScanner

Implements

INotifyPropertyChanged

IBluetoothScanner

IAsyncDisposable

Inherited Members

BaseBluetoothScanner.AdvertisementReceived

BaseBluetoothScanner.AdvertisementFilter

BaseBluetoothScanner.DeviceWrapper

BaseBluetoothScanner.OnAdvertisementReceived<TAdvertisement>(TAdvertisement)

BaseBluetoothScanner.OnAdvertisementsReceived(IEnumerable<IBluetoothAdvertisement>)

BaseBluetoothScanner.Adapter

BaseBluetoothScanner.NameProvider

BaseBluetoothScanner.ScanningOptionsFactory

BaseBluetoothScanner.SignalStrengthSmoothingOptionsFactory

BaseBluetoothScanner.ScanningOptions

BaseBluetoothScanner.RssiToSignalStrengthConverter

BaseBluetoothScanner.LoggerFactory

BaseBluetoothScanner.RefreshAsync(CancellationToken)

BaseBluetoothScanner.ToString()

BaseBluetoothScanner.HasScannerPermissionsAsync()

BaseBluetoothScanner.RequestScannerPermissionsAsync(bool, CancellationToken)

BaseBluetoothScanner.DisposeAsyncCore()

BaseBluetoothScanner.DisposeAsync()

BaseBluetoothScanner.HasDevice(Func<IBluetoothRemoteDevice, bool>)

BaseBluetoothScanner.HasDevice(string)

BaseBluetoothScanner.DeviceListChanged

BaseBluetoothScanner.DevicesAdded

BaseBluetoothScanner.DevicesRemoved

BaseBluetoothScanner.ClearDevicesAsync(IEnumerable<IBluetoothRemoteDevice>)

BaseBluetoothScanner.ClearDeviceAsync(IBluetoothRemoteDevice)

BaseBluetoothScanner.ClearDeviceAsync(string)

BaseBluetoothScanner.GetDevice(Func<IBluetoothRemoteDevice, bool>)

BaseBluetoothScanner.GetDevice(string)

BaseBluetoothScanner.GetDeviceOrDefault(Func<IBluetoothRemoteDevice, bool>)

BaseBluetoothScanner.GetDeviceOrDefault(string)

BaseBluetoothScanner.GetDevices(Func<IBluetoothRemoteDevice, bool>)

BaseBluetoothScanner.WaitForDeviceToAppearAsync(string, TimeSpan?, CancellationToken)

BaseBluetoothScanner.WaitForDeviceToAppearAsync(Func<IBluetoothRemoteDevice, bool>, TimeSpan?, CancellationToken)

BaseBluetoothScanner.GetClosestDeviceOrDefault(Func<IBluetoothRemoteDevice, bool>)

BaseBluetoothScanner.RunningStateChanged

BaseBluetoothScanner.IsRunning

BaseBluetoothScanner.OnIsRunningChanged(bool)

BaseBluetoothScanner.IsStarting

BaseBluetoothScanner.Starting

BaseBluetoothScanner.Started

BaseBluetoothScanner.OnStartSucceeded()

BaseBluetoothScanner.OnStartFailed(Exception)

BaseBluetoothScanner.StartScanningIfNeededAsync(ScanningOptions, PermissionOptions, TimeSpan?, CancellationToken)

BaseBluetoothScanner.StartScanningAsync(ScanningOptions, PermissionOptions, TimeSpan?, CancellationToken)

BaseBluetoothScanner.HandlePermissionsAsync(PermissionOptions, CancellationToken)

BaseBluetoothScanner.HandlePermissionsAsync(PermissionRequestStrategy, bool, CancellationToken)

BaseBluetoothScanner.IsStopping

BaseBluetoothScanner.Stopping

BaseBluetoothScanner.Stopped

BaseBluetoothScanner.OnStopSucceeded()

BaseBluetoothScanner.OnStopFailed(Exception)

BaseBluetoothScanner.StopScanningIfNeededAsync(TimeSpan?, CancellationToken)

BaseBluetoothScanner.StopScanningAsync(TimeSpan?, CancellationToken)

BaseBluetoothScanner.CleanRestartScanningAsync(Func<IBluetoothAdvertisement, bool>, ScanningOptions, PermissionOptions, TimeSpan?, CancellationToken)

BaseBindableObject.Logger

BaseBindableObject._logger

BaseBindableObject.PropertyChanged

BaseBindableObject.HasValue(string)

BaseBindableObject.GetValue<T>(T, string)

BaseBindableObject.GetValueOrDefault<T>(T, string)

BaseBindableObject.SetValue<T>(T, string)

BaseBindableObject.ClearValue(string)

BaseBindableObject.OnPropertyChanged(string)

BaseBindableObject.WaitForPropertyToBeOfValue<T>(string, T, TimeSpan?, CancellationToken)

BaseBindableObject.WaitForPropertyToBeDifferentThanValue<T>(string, T, TimeSpan?, CancellationToken)

BaseBindableObject.WaitForPropertyToBe<T>(string, Func<T, bool>, TimeSpan?, CancellationToken)

BaseBindableObject.WaitForPropertyToChange<T>(string, TimeSpan?, CancellationToken)

BaseBindableObject.WaitForPropertyToChangeNotNull<T>(string, TimeSpan?, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

DotNetCoreBluetoothScanner(IBluetoothAdapter, IBluetoothRssiToSignalStrengthConverter, ITicker, IBluetoothNameProvider?, ILoggerFactory?)

Initializes a new instance of the BaseBluetoothScanner class.

public DotNetCoreBluetoothScanner(IBluetoothAdapter adapter, IBluetoothRssiToSignalStrengthConverter rssiToSignalStrengthConverter, ITicker ticker, IBluetoothNameProvider? nameProvider = null, ILoggerFactory? loggerFactory = null)

Parameters

adapter IBluetoothAdapter

The Bluetooth adapter associated with this scanner.

rssiToSignalStrengthConverter IBluetoothRssiToSignalStrengthConverter

The converter for RSSI to signal strength.

ticker ITicker

The ticker for scheduling periodic refresh tasks.

nameProvider IBluetoothNameProvider

Optional provider for Bluetooth device names.

loggerFactory ILoggerFactory

Optional logger factory for creating loggers.

Exceptions

PlatformNotSupportedException

Methods

NativeCreateDeviceFromAdvertisement(IBluetoothAdvertisement)

Creates a factory request for creating a Bluetooth device based on the received advertisement.

protected override IBluetoothRemoteDevice NativeCreateDeviceFromAdvertisement(IBluetoothAdvertisement advertisement)

Parameters

advertisement IBluetoothAdvertisement

The received Bluetooth advertisement.

Returns

IBluetoothRemoteDevice

A factory request containing the necessary information to create a Bluetooth device.

Exceptions

PlatformNotSupportedException

NativeHasScannerPermissionsAsync()

Platform-specific implementation to check if scanner permissions are granted.

protected override ValueTask<bool> NativeHasScannerPermissionsAsync()

Returns

ValueTask<bool>

True if permissions are granted, otherwise false.

Remarks

Implement platform-specific permission checks. Should NOT throw exceptions. Return false if permissions cannot be determined.

Exceptions

PlatformNotSupportedException

NativeRefreshIsRunning()

Refreshes the native running state from the underlying platform.

protected override void NativeRefreshIsRunning()

Exceptions

PlatformNotSupportedException

NativeRequestScannerPermissionsAsync(bool, CancellationToken)

Platform-specific implementation to request scanner permissions.

protected override ValueTask NativeRequestScannerPermissionsAsync(bool requireBackgroundLocation, CancellationToken cancellationToken)

Parameters

requireBackgroundLocation bool

Android-only: whether to request background location.

cancellationToken CancellationToken

Cancellation token to cancel the permission request operation.

Returns

ValueTask

Remarks

Implement platform-specific permission request dialogs. Throw native exceptions on failure - base class will wrap them in BluetoothPermissionException.

Exceptions

Exception

Throw platform-specific exceptions (SecurityException, COMException, etc.) on failure.

PlatformNotSupportedException

NativeStartAsync(ScanningOptions, TimeSpan?, CancellationToken)

Starts the native Bluetooth scanner with the specified options. This method is called by StartScanningAsync(ScanningOptions?, PermissionOptions?, TimeSpan?, CancellationToken) to perform platform-specific start operations.

protected override ValueTask NativeStartAsync(ScanningOptions scanningOptions, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

scanningOptions ScanningOptions

The scanning options to use when starting the scanner.

timeout TimeSpan?

An optional timeout for the start operation.

cancellationToken CancellationToken

An optional cancellation token to cancel the start operation.

Returns

ValueTask

Exceptions

PlatformNotSupportedException

NativeStopAsync(TimeSpan?, CancellationToken)

Stops the native Bluetooth scanner. This method is called by StopScanningAsync(TimeSpan?, CancellationToken) to perform platform-specific stop operations.

protected override ValueTask NativeStopAsync(TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

timeout TimeSpan?

cancellationToken CancellationToken

Returns

ValueTask

Exceptions

PlatformNotSupportedException