Advertisement Event

Fired when an advertisement packet is received during scanning.

Syntax

• C#
• VB.NET

public event OnAdvertisementHandler OnAdvertisement;

public delegate void OnAdvertisementHandler(object sender, BleclientAdvertisementEventArgs e);

public class BleclientAdvertisementEventArgs : EventArgs {
  public string ServerId { get; }
  public string Name { get; }
  public int RSSI { get; }
  public int TxPower { get; }
  public string ServiceUuids { get; }
  public string ServicesWithData { get; }
  public string SolicitedServiceUuids { get; }
  public int ManufacturerCompanyId { get; }
  public string ManufacturerData { get; }
  public byte[] ManufacturerDataB { get; }
  public bool IsConnectable { get; }
  public bool IsScanResponse { get; }
}

Public Event OnAdvertisement As OnAdvertisementHandler

Public Delegate Sub OnAdvertisementHandler(sender As Object, e As BleclientAdvertisementEventArgs)

Public Class BleclientAdvertisementEventArgs Inherits EventArgs
  Public ReadOnly Property ServerId As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property RSSI As Integer
  Public ReadOnly Property TxPower As Integer
  Public ReadOnly Property ServiceUuids As String
  Public ReadOnly Property ServicesWithData As String
  Public ReadOnly Property SolicitedServiceUuids As String
  Public ReadOnly Property ManufacturerCompanyId As Integer
  Public ReadOnly Property ManufacturerData As String
  Public ReadOnly Property ManufacturerDataB As Byte()
  Public ReadOnly Property IsConnectable As Boolean
  Public ReadOnly Property IsScanResponse As Boolean
End Class

Remarks

The Advertisement event is fired each time an advertisement is received while the component is Scanning for servers to connect to. Based on the information in the advertisement, you can decide whether or not you wish to connect to the associated device (if it is connectable).

Not all of the parameters are relevant for all platforms. Additionally, since advertisement packets are somewhat flexible in their contents, it is not guaranteed that every parameter relevant to your platform will be populated for every advertisement. Please refer to the following table for descriptions of the parameters:

Setting the ServiceData configuration setting to any of the service UUIDs in the ServicesWithData parameter will return the associated data.

You can use the ManufacturerDataCount configuration setting to determine whether the advertisement contains multiple manufacturer data sections; if it does, the ManufacturerData and ManufacturerCompanyId configuration settings can be used to iterate over them.

Note that all of the configuration settings mentioned above are only valid while you are within the Advertisement event handler.

Please refer to the following table to determine which parameters are relevant for your platform:

Note: IsConnectable will always be false when IsScanResponse is true.

Refer to the StartScanning method for more information.