Class BluetoothGattClient

Definition

Namespace:
Tizen.Network.Bluetooth
Assembly:
Tizen.Network.Bluetooth.dll
API Level:
3

The Bluetooth GATT client.

C#
Copy
public class BluetoothGattClient : IDisposable
Inheritance
BluetoothGattClient
Implements
System.IDisposable

Properties

View Source

RemoteAddress

The address of the remote device.

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

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

API Level: 3

Methods

View Source

ConnectAsync(Boolean)

Connects to the remote GATT server asynchronously.

Declaration
C#
Copy
public Task ConnectAsync(bool autoConnect)
Parameters
Type Name Description
System.Boolean 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.

API Level: 6
Privilege Level: public
Privilege: http://tizen.org/privilege/bluetooth
Feature: http://tizen.org/feature/network.bluetooth.le.gatt.client
View Source

CreateClient(String)

Creates the Bluetooth GATT client.

Declaration
C#
Copy
public static BluetoothGattClient CreateClient(string remoteAddress)
Parameters
Type Name Description
System.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.

API Level: 6
Feature: http://tizen.org/feature/network.bluetooth.le.gatt.client
View Source

DestroyClient()

Destroy Bluetooth GATT client

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

DisconnectAsync()

Disconnects to the remote GATT server asynchronously.

Declaration
C#
Copy
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.

API Level: 6
Privilege Level: public
Privilege: http://tizen.org/privilege/bluetooth
Feature: http://tizen.org/feature/network.bluetooth.le.gatt.client
View Source

Dispose()

Destroys the current object.

Declaration
C#
Copy
public void Dispose()
API Level: 6
Feature: http://tizen.org/feature/network.bluetooth.le.gatt.client
View Source

Dispose(Boolean)

Releases all the resources currently used by this instance.

Declaration
C#
Copy
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

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

API Level: 6
View Source

Finalize()

Destroys the current object.

Declaration
C#
Copy
protected void Finalize()
View Source

GetService(String)

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

Declaration
C#
Copy
public BluetoothGattService GetService(string uuid)
Parameters
Type Name Description
System.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.

API Level: 3
View Source

GetServices()

Gets list of services that belongs to the remote device.

Declaration
C#
Copy
public IEnumerable<BluetoothGattService> GetServices()
Returns
Type Description
System.Collections.Generic.IEnumerable<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.

API Level: 3
View Source

ReadValueAsync(BluetoothGattCharacteristic)

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

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

The characteristic to be read.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

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.

API Level: 3
View Source

ReadValueAsync(BluetoothGattDescriptor)

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

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

The descriptor to be read.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

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.

API Level: 3
View Source

WriteValueAsync(BluetoothGattCharacteristic)

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

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

The characteristic to be written.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

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.

API Level: 3
View Source

WriteValueAsync(BluetoothGattDescriptor)

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

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

The descriptor to be written.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

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.

API Level: 3

Events

View Source

ConnectionStateChanged

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

Declaration
C#
Copy
public event EventHandler<GattConnectionStateChangedEventArgs> ConnectionStateChanged
Event Type
Type Description
System.EventHandler<GattConnectionStateChangedEventArgs>
API Level: 6

Implements

System.IDisposable