Click or drag to resize

wclBluetoothLeProximityBeaconConnection Class

The virtual connection represents a Bluetooth LE Proximity Beacon (iBeacon).
Inheritance Hierarchy

Namespace:  wclBluetooth
Assembly:  wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.5.9.0 (7.5.9.0)
Syntax
public abstract class wclBluetoothLeProximityBeaconConnection : wclBluetoothLeUuidAdvertiserConnection

The wclBluetoothLeProximityBeaconConnection type exposes the following members.

Constructors
  NameDescription
Public methodwclBluetoothLeProximityBeaconConnection
Creates a new "virtual" Bluetooth LE Proximity Beacon Advertising connection object.
Top
Properties
  NameDescription
Public propertyAdvertiserName
Gets and sets the advertiser name.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Public propertyAdvertising
Gets advertising state.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Public propertyCompanyId
Gets and sets the beacon's manufacturer ID.
(Inherited from wclBluetoothLeUuidAdvertiserConnection.)
Public propertyMajor
Gets and sets the beacon's Major value.
(Inherited from wclBluetoothLeUuidAdvertiserConnection.)
Public propertyMinor
Gets and sets the beacon's Minor value.
(Inherited from wclBluetoothLeUuidAdvertiserConnection.)
Public propertyRadio
Gets the connection owner.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Public propertyReceiver
Gets the connection message receiver object.
(Inherited from wclCustomConnection.)
Public propertyThreadId
Gets the connection's thread ID.
(Inherited from wclCustomConnection.)
Public propertyTxRssi
Gets and sets the beacon's RSSI value.
(Inherited from wclBluetoothLeRssiAdvertiserConnection.)
Public propertyUuid
Gets and seys the beacon's UUID.
(Inherited from wclBluetoothLeUuidAdvertiserConnection.)
Top
Methods
  NameDescription
Protected methodDoStarted
Fires the OnStarted event.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Protected methodDoStopped
Fires the OnStopped event.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Protected methodHalStart
Implements a hardware depended code to start Bluetooth LE advertising.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Protected methodHalStop
Implements a hardware depended code to stop Bluetooth LE advertising.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMessageReceived
The method called when a new notification message received.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Public methodStart
Starts Bluetooth LE Advertising.
(Inherited from wclBluetoothLeRssiAdvertiserConnection.)
Public methodStop
Stops Bluetooth LE Advertising.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventOnStarted
The event fires when the Bluetooth LE advertising started.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Public eventOnStopped
The event fires when the Bluetooth LE advertising stopped.
(Inherited from wclBluetoothLeAdvertiserConnection.)
Top
Remarks

The class provides methods to enable Bluetooth LE Proximity Beacon Advertising.

The feature is supported only on Windows 10 platform with Microsoft Bluetooth drivers.

See Also