Class BluetoothGattClient

Definition

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

The Bluetooth GATT client.

public class BluetoothGattClient : IDisposable
Inheritance
object
BluetoothGattClient
Implements
System.IDisposable

Properties

View Source

RemoteAddress

The address of the remote device.

Declaration
public string RemoteAddress { get; }
Property Value
Type Description
string
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the BT/BTLE is not enabled or when the remote device is disconnected.

Methods

View Source

ConnectAsync(bool)

Connects to the remote GATT server asynchronously.

Declaration
public Task ConnectAsync(bool autoConnect)
Parameters
Type Name Description
bool autoConnect

The flag for reconnecting when the connection is disconnceted.
Returns
Type Description
System.Threading.Tasks.Task

A task indicating whether the method is done or not.
Exceptions
Type Condition
System.NotSupportedException

Thrown when the BT/BTLE is not supported.
System.InvalidOperationException

Thrown when the create GATT client fails.
View Source

CreateClient(string)

Creates the Bluetooth GATT client.

Declaration
public static BluetoothGattClient CreateClient(string remoteAddress)
Parameters
Type Name Description
string remoteAddress

The remote device address.
Returns
Type Description
BluetoothGattClient

The BluetoothGattClient instance.
Exceptions
Type Condition
System.NotSupportedException

Thrown when the BT/BTLE is not supported.
System.InvalidOperationException

Thrown when the create GATT client fails.
View Source

DestroyClient()

Destroy Bluetooth GATT client

Declaration
[Obsolete("Deprecated since API level 6. Please use Dispose() method on BluetoothGattClient.")]
public void DestroyClient()
View Source

DisconnectAsync()

Disconnects to the remote GATT server asynchronously.

Declaration
public Task DisconnectAsync()
Returns
Type Description
System.Threading.Tasks.Task

A task indicating whether the method is done or not.
Exceptions
Type Condition
System.NotSupportedException

Thrown when the BT/BTLE is not supported.
System.InvalidOperationException

Thrown when the create GATT client fails.
View Source

Dispose()

Destroys the current object.

Declaration
public void Dispose()
View Source

Dispose(bool)

Releases all the resources currently used by this instance.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true if the managed resources should be disposed, otherwise false.
View Source

~BluetoothGattClient()

Destroys the current object.

Declaration
protected ~BluetoothGattClient()
View Source

GetService(string)

Gets the service with the given UUID that belongs to the remote device.

Declaration
public BluetoothGattService GetService(string uuid)
Parameters
Type Name Description
string uuid

The UUID for the service to get.
Returns
Type Description
BluetoothGattService

The service with the given UUID if it exists, null otherwise.
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the BT/BTLE is not enabled or when the remote device is disconnected, or when the get service fails.
View Source

GetServices()

Gets list of services that belongs to the remote device.

Declaration
public IEnumerable<BluetoothGattService> GetServices()
Returns
Type Description
System.Collections.Generic.IEnumerable<T><BluetoothGattService>

The list of services that belongs to the remote device.
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the BT/BTLE is not enabled or when the remote device is disconnected, or when the get service fails.
View Source

ReadValueAsync(BluetoothGattCharacteristic)

Reads the value of a given characteristic from the remote device asynchronously.

Declaration
public Task<bool> ReadValueAsync(BluetoothGattCharacteristic characteristic)
Parameters
Type Name Description
BluetoothGattCharacteristic characteristic

The characteristic to be read.
Returns
Type Description
System.Threading.Tasks.Task<TResult><bool>

true on success, false otherwise.
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the BT/BTLE is not enabled or when the remote device is disconnected, or when the read attribute value fails.
View Source

ReadValueAsync(BluetoothGattDescriptor)

Reads the value of the given descriptor from the remote device asynchronously.

Declaration
public Task<bool> ReadValueAsync(BluetoothGattDescriptor descriptor)
Parameters
Type Name Description
BluetoothGattDescriptor descriptor

The descriptor to be read.
Returns
Type Description
System.Threading.Tasks.Task<TResult><bool>

true on success, false otherwise.
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the BT/BTLE is not enabled or when the remote device is disconnected, or when the read attribute value fails.
View Source

WriteValueAsync(BluetoothGattCharacteristic)

Writes the value of a given characteristic to the remote device asynchronously.

Declaration
public Task<bool> WriteValueAsync(BluetoothGattCharacteristic characteristic)
Parameters
Type Name Description
BluetoothGattCharacteristic characteristic

The characteristic to be written.
Returns
Type Description
System.Threading.Tasks.Task<TResult><bool>

true on success, false otherwise.
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the BT/BTLE is not enabled or when the remote device is disconnected or when the write attribute value fails.
View Source

WriteValueAsync(BluetoothGattDescriptor)

Writes the value of the given descriptor to the remote device asynchronously.

Declaration
public Task<bool> WriteValueAsync(BluetoothGattDescriptor descriptor)
Parameters
Type Name Description
BluetoothGattDescriptor descriptor

The descriptor to be written.
Returns
Type Description
System.Threading.Tasks.Task<TResult><bool>

true on success, false otherwise.
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the BT/BTLE is not enabled or when the remote device is disconnected, or when the write attribute value fails.

Events

View Source

ConnectionStateChanged

The ConnectionStateChanged event is raised when the gatt connection state is changed.

Declaration
public event EventHandler<GattConnectionStateChangedEventArgs> ConnectionStateChanged
Event Type
Type Description
System.EventHandler<TEventArgs><GattConnectionStateChangedEventArgs>
View Source

ServiceChanged

The ServiceChanged event is raised when the service is changed from the remote device(GATT server).

Declaration
public event EventHandler<ServiceChangedEventArgs> ServiceChanged
Event Type
Type Description
System.EventHandler<TEventArgs><ServiceChangedEventArgs>

Implements

System.IDisposable