BluetoothLEAdvertisementReceivedEventArgs Class

  • Reference

Definition

Namespace:
Windows.Devices.Bluetooth.Advertisement
Edit

Provides data for a Received event on a BluetoothLEAdvertisementWatcher. A BluetoothLEAdvertisementReceivedEventArgs instance is created when the Received event occurs on a BluetoothLEAdvertisementWatcher object.

public ref class BluetoothLEAdvertisementReceivedEventArgs sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BluetoothLEAdvertisementReceivedEventArgs final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BluetoothLEAdvertisementReceivedEventArgs
Public NotInheritable Class BluetoothLEAdvertisementReceivedEventArgs
Inheritance
Object Platform::Object IInspectable BluetoothLEAdvertisementReceivedEventArgs
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)
App capabilities
bluetooth

Remarks

Per BluetoothSignalStrengthFilter, when the device signal goes out of range, an "out of range" event will be sent, containing the advertisement data last seen, with the RawSignalStrengthInDBm value set to -127.

Version history

Windows version SDK version Value added
2004 19041 BluetoothAddressType
2004 19041 IsAnonymous
2004 19041 IsConnectable
2004 19041 IsDirected
2004 19041 IsScannable
2004 19041 IsScanResponse
2004 19041 TransmitPowerLevelInDBm

Properties

Advertisement

Gets the Bluetooth LE advertisement payload data received.
AdvertisementType

Gets the type of the received Bluetooth LE advertisement packet.
BluetoothAddress

Gets the Bluetooth address of the device sending the Bluetooth LE advertisement.
BluetoothAddressType

Retrieves the Bluetooth Address Type of the received advertisement.
IsAnonymous

Indicates whether a Bluetooth Address was omitted from the received advertisement.
IsConnectable

Indicates whether the received advertisement is connectable.
IsDirected

Indicates whether the received advertisement is directed.
IsScannable

Indicates whether the received advertisement is scannable.
IsScanResponse

Indicates whether the received advertisement is a scan response.
PrimaryPhy
RawSignalStrengthInDBm

Gets the received signal strength indicator (RSSI) value, in dBm, for this received Bluetooth LE advertisement event. This value could be the raw RSSI or a filtered RSSI depending on filtering settings configured through BluetoothSignalStrengthFilter.
SecondaryPhy
Timestamp

Gets the timestamp when the Received event occurred.
TransmitPowerLevelInDBm

Represents the received transmit power of the advertisement.

Applies to

See also