Class BluetoothLeDevice

    Definition

    Namespace:
    Tizen.Network.Bluetooth
    Assembly:
    Tizen.Network.Bluetooth.dll

    This is the BluetoothLeDevice class. It handles the LE device operations like getting data from the scan result.

    public class BluetoothLeDevice
    Inheritance
    object
    BluetoothLeDevice

    Properties

    View Source

    AddressType

    The type of the address.

    Declaration
    public BluetoothLeDeviceAddressType AddressType { get; }
    Property Value
    Type Description
    BluetoothLeDeviceAddressType
    View Source

    AdvertsingDataInformation

    The advertsing data information.

    Declaration
    public byte[] AdvertsingDataInformation { get; }
    Property Value
    Type Description
    byte[]
    View Source

    Appearance

    Gets the manufacturer data from the scan result.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use GetAppearance() method on BluetoothLeDevice.")]
    public int Appearance { get; }
    Property Value
    Type Description
    int

    Gets the appearance value.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    DeviceName

    Gets the device name from the LE scan result.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use GetDeviceName() method on BluetoothLeDevice.")]
    public string DeviceName { get; }
    Property Value
    Type Description
    string

    Gets the device name.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    ManufacturerData

    Gets the manufacturer data from the scan result.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use GetManufacturerData() method on BluetoothLeDevice.")]
    public ManufacturerData ManufacturerData { get; }
    Property Value
    Type Description
    ManufacturerData

    Gets the manufacturer data containing the manucturer data and ID information.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    PacketType

    The type of the packet.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use new methods with this type on BluetoothLeDevice.")]
    public BluetoothLePacketType PacketType { get; set; }
    Property Value
    Type Description
    BluetoothLePacketType
    View Source

    RemoteAddress

    The remote address.

    Declaration
    public string RemoteAddress { get; }
    Property Value
    Type Description
    string
    View Source

    Rssi

    The rssi value.

    Declaration
    public int Rssi { get; }
    Property Value
    Type Description
    int
    View Source

    ScanDataInformation

    The scan data information.

    Declaration
    public byte[] ScanDataInformation { get; }
    Property Value
    Type Description
    byte[]
    View Source

    ServiceSolictationUuid

    Gets the service solicitation UUID list from the scan result.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use GetServiceSolicitationUuid() method on BluetoothLeDevice.")]
    public IEnumerable<string> ServiceSolictationUuid { get; }
    Property Value
    Type Description
    System.Collections.Generic.IEnumerable<T><string>

    Gets the list of the service solicitation UUIDs.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    ServiceUuid

    Gets the service UUIDs list from the LE scan result.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use GetServiceUuid() method on BluetoothLeDevice.")]
    public IEnumerable<string> ServiceUuid { get; }
    Property Value
    Type Description
    System.Collections.Generic.IEnumerable<T><string>

    Gets the list of the string service UUIDs.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    TxPowerLevel

    Gets the transmission power level from the LE scan result.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use GetTxPowerLevel() method on BluetoothLeDevice.")]
    public int TxPowerLevel { get; }
    Property Value
    Type Description
    int

    Gets the transmission power level in dB.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    Methods

    View Source

    GattConnect(bool)

    Creates a GATT connection with the remote device.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use CreateClient() and ConnectAsync() method on BluetoothGattClient.")]
    public BluetoothGattClient GattConnect(bool autoConnect)
    Parameters
    Type Name Description
    bool autoConnect

    The auto connect flag.

    Returns
    Type Description
    BluetoothGattClient

    client instance

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled or when the gatt connection attempt to remote device fails.

    View Source

    GattDisconnect()

    Disconnects a GATT connection with the remote device.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use DisconnectAsync() method on BluetoothGattClient.")]
    public void GattDisconnect()
    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled or when the GATT disconnection attempt to remote device fails.

    View Source

    GetAppearance(BluetoothLePacketType)

    Gets the manufacturer data from the scan result.

    Declaration
    public int GetAppearance(BluetoothLePacketType packetType)
    Parameters
    Type Name Description
    BluetoothLePacketType packetType

    The enumeration for BLE packet type.

    Returns
    Type Description
    int

    Gets the appearance value.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    GetDeviceName(BluetoothLePacketType)

    Gets the device name from the LE scan result.

    Declaration
    public string GetDeviceName(BluetoothLePacketType packetType)
    Parameters
    Type Name Description
    BluetoothLePacketType packetType

    The enumeration for BLE packet type.

    Returns
    Type Description
    string

    Gets the device name.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    GetManufacturerData(BluetoothLePacketType)

    Gets the manufacturer data from the scan result.

    Declaration
    public ManufacturerData GetManufacturerData(BluetoothLePacketType packetType)
    Parameters
    Type Name Description
    BluetoothLePacketType packetType

    The enumeration for BLE packet type.

    Returns
    Type Description
    ManufacturerData

    Gets the manufacturer data containing the manucturer data and ID information.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    GetServiceDataList()

    Gets the service data list from the scan result.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use GetServiceDataList() method on BluetoothLeDevice.")]
    public IEnumerable<BluetoothLeServiceData> GetServiceDataList()
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T><BluetoothLeServiceData>

    Returns the service data list.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    GetServiceDataList(BluetoothLePacketType)

    Gets the service data list from the scan result.

    Declaration
    public IEnumerable<BluetoothLeServiceData> GetServiceDataList(BluetoothLePacketType packetType)
    Parameters
    Type Name Description
    BluetoothLePacketType packetType

    The packet type.

    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T><BluetoothLeServiceData>

    Returns the service data list.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    GetServiceSolicitationUuid(BluetoothLePacketType)

    Gets the service solicitation UUID list from the scan result.

    Declaration
    public IEnumerable<string> GetServiceSolicitationUuid(BluetoothLePacketType packetType)
    Parameters
    Type Name Description
    BluetoothLePacketType packetType

    The enumeration for BLE packet type.

    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T><string>

    Gets the list of the service solicitation UUIDs.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    GetServiceUuid(BluetoothLePacketType)

    Gets the service UUIDs list from the LE scan result.

    Declaration
    public IEnumerable<string> GetServiceUuid(BluetoothLePacketType packetType)
    Parameters
    Type Name Description
    BluetoothLePacketType packetType

    The enumeration for BLE packet type.

    Returns
    Type Description
    System.Collections.Generic.IEnumerable<T><string>

    Gets the list of the string service UUIDs.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    View Source

    GetTxPowerLevel(BluetoothLePacketType)

    Gets the transmission power level from the LE scan result.

    Declaration
    public int GetTxPowerLevel(BluetoothLePacketType packetType)
    Parameters
    Type Name Description
    BluetoothLePacketType packetType

    The enumeration for BLE packet type.

    Returns
    Type Description
    int

    Gets the transmission power level in dB.

    Remarks

    The Bluetooth must be enabled.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the Bluetooth LE is not supported.

    System.InvalidOperationException

    Thrown when the Bluetooth LE is not enabled.

    Events

    View Source

    GattConnectionStateChanged

    This event is called when the GATT client connects/disconnects with the server.

    Declaration
    [Obsolete("Deprecated since API level 6. Please use ConnectionStateChanged event on BluetoothGattClient.")]
    public event EventHandler<GattConnectionStateChangedEventArgs> GattConnectionStateChanged
    Event Type
    Type Description
    System.EventHandler<TEventArgs><GattConnectionStateChangedEventArgs>
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX