32feet/InTheHand.Net.Bluetooth/BluetoothDeviceInfo.cs

// 32feet.NET - Personal Area Networking for .NET
//
// InTheHand.Net.Sockets.BluetoothDeviceInfo
// 
// Copyright (c) 2003-2022 In The Hand Ltd, All rights reserved.
// This source code is licensed under the MIT License

using InTheHand.Net.Bluetooth;
using System;
using System.Collections.Generic;

namespace InTheHand.Net.Sockets
{
    /// <summary>
    /// Provides information about an available device obtained by the client during device discovery.
    /// </summary>
    public sealed partial class BluetoothDeviceInfo : IEquatable<BluetoothDeviceInfo>
    {
        /// <summary>
        /// Forces the system to refresh the device information.
        /// </summary>
        public void Refresh()
        {
            DoRefresh();
        }

        /// <summary>
        /// Gets the device identifier.
        /// </summary>
        public BluetoothAddress DeviceAddress
        {
            get
            {
                return GetDeviceAddress();
            }
        }

        /// <summary>
        /// Gets the name of a device.
        /// </summary>
        public string DeviceName
        {
            get
            {
                return GetDeviceName();
            }
        }

        /// <summary>
        /// Returns the Class of Device of the remote device.
        /// </summary>
        public ClassOfDevice ClassOfDevice
        {
            get
            {
                return GetClassOfDevice();
            }
        }

        /// <summary>
        /// Returns a list of services which are already installed for use on the calling machine.
        /// </summary>
        public IReadOnlyCollection<Guid> InstalledServices
        {
            get
            {
                return GetInstalledServices();
            }
        }

        /// <summary>
        /// Specifies whether the device is connected.
        /// </summary>
        public bool Connected
        {
            get
            {
                return GetConnected();
            }
        }

        /// <summary>
        /// Specifies whether the device is authenticated, paired, or bonded.
        /// All authenticated devices are remembered.
        /// </summary>
        public bool Authenticated
        {
            get
            {
                return GetAuthenticated();
            }
        }

        /// <summary>
        /// Enables or disables services for a Bluetooth device.
        /// </summary>
        /// <remarks>Only applies to Windows platform.</remarks>
        /// <param name="service"></param>
        /// <param name="state"></param>
        public void SetServiceState(Guid service, bool state)
        {
            DoSetServiceState(service, state);
        }

        /// <summary>
        /// Compares two BluetoothDeviceInfo instances for equality.
        /// </summary>
        /// <param name="other"></param>
        /// <returns></returns>
        public bool Equals(BluetoothDeviceInfo other)
        {
            if (other is null)
                return false;

            return DeviceAddress == other.DeviceAddress;
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="obj"></param>
        /// <returns></returns>
        public override bool Equals(object obj)
        {
            if(obj is BluetoothDeviceInfo info)
            {
                return Equals(info);
            }

            return false;
        }

        /// <summary>
        /// 
        /// </summary>
        /// <returns></returns>
        public override int GetHashCode()
        {
            return DeviceAddress.GetHashCode();
        }
    }
}