• Articles
  • API Documentation
  • BuzzLockGui.Backend
  • BluetoothDevice
Show / Hide Table of Contents
  • BuzzLockGui
    • FormBuzzLock
    • FormBuzzLock.State
    • FormOptions
    • FormStart
    • FormUserManagement
  • BuzzLockGui.Backend
    • AuthenticationMethod
    • AuthenticationMethods
    • AuthenticationSequence
    • BluetoothAddress
    • BluetoothDevice
    • BluetoothService
    • BluetoothService.BluetoothMode
    • Card
    • Pin
    • User
    • User.PermissionLevels

Class BluetoothDevice

Allows a user to authenticate using a Bluetooth device.

Inheritance
System.Object
AuthenticationMethod
BluetoothDevice
Implements
System.IEquatable<BluetoothDevice>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: BuzzLockGui.Backend
Assembly: BuzzLockGui.dll
Syntax
public class BluetoothDevice : AuthenticationMethod, IEquatable<BluetoothDevice>

Constructors

BluetoothDevice(BluetoothAddress)

Creates a new Bluetooth device with the given address.

Declaration
public BluetoothDevice(BluetoothAddress address)
Parameters
Type Name Description
BluetoothAddress address

BluetoothDevice(BluetoothAddress, String)

Creates a new Bluetooth device with the given address and name.

Declaration
public BluetoothDevice(BluetoothAddress address, string name)
Parameters
Type Name Description
BluetoothAddress address
System.String name

Fields

Address

The address of this Bluetooth device.

Declaration
public readonly BluetoothAddress Address
Field Value
Type Description
BluetoothAddress

Properties

Name

The name of this Bluetooth device.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
Remarks

Unless set explicitly, this name is accessed from the table of users in the database. When adding a new Bluetooth device as an authentication method, this name must be set explicitly, as the device does not exist in the users table of the database.

Methods

Equals(BluetoothDevice)

Declaration
public bool Equals(BluetoothDevice other)
Parameters
Type Name Description
BluetoothDevice other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
AuthenticationMethod.Equals(Object)

GetAllAvailable()

Gets all available Bluetooth devices. This is an alias for GetAvailableBluetoothDevices().

Declaration
public static IEnumerable<BluetoothDevice> GetAllAvailable()
Returns
Type Description
System.Collections.Generic.IEnumerable<BluetoothDevice>

An System.Collections.Generic.IEnumerable<T> of the available BluetoothDevices.

Remarks

See the documentation for GetAvailableBluetoothDevices() for details, including how the Mode changes what is considered available by this method.

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
AuthenticationMethod.GetHashCode()

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Implements

System.IEquatable<T>
In This Article
  • Constructors
    • BluetoothDevice(BluetoothAddress)
    • BluetoothDevice(BluetoothAddress, String)
  • Fields
    • Address
  • Properties
    • Name
  • Methods
    • Equals(BluetoothDevice)
    • Equals(Object)
    • GetAllAvailable()
    • GetHashCode()
    • ToString()
  • Implements
Back to top Generated by DocFX