Most visited

Recently visited

Results for

Added in API level 18

BluetoothGattDescriptor

public class BluetoothGattDescriptor
extends Object implements Parcelable

java.lang.Object
↳	android.bluetooth.BluetoothGattDescriptor

Represents a Bluetooth GATT Descriptor

GATT Descriptors contain additional information and attributes of a GATT characteristic, BluetoothGattCharacteristic. They can be used to describe the characteristic's features or to control certain behaviours of the characteristic.

Summary

Constants
`int`	`PERMISSION_READ` Descriptor read permission
`int`	`PERMISSION_READ_ENCRYPTED` Descriptor permission: Allow encrypted read operations
`int`	`PERMISSION_READ_ENCRYPTED_MITM` Descriptor permission: Allow reading with man-in-the-middle protection
`int`	`PERMISSION_WRITE` Descriptor write permission
`int`	`PERMISSION_WRITE_ENCRYPTED` Descriptor permission: Allow encrypted writes
`int`	`PERMISSION_WRITE_ENCRYPTED_MITM` Descriptor permission: Allow encrypted writes with man-in-the-middle protection
`int`	`PERMISSION_WRITE_SIGNED` Descriptor permission: Allow signed write operations
`int`	`PERMISSION_WRITE_SIGNED_MITM` Descriptor permission: Allow signed write operations with man-in-the-middle protection

Inherited constants

From interface android.os.Parcelable

Fields
`public static final Creator<BluetoothGattDescriptor>`	`CREATOR`
`public static final byte[]`	`DISABLE_NOTIFICATION_VALUE` Value used to disable notifications or indicatinos
`public static final byte[]`	`ENABLE_INDICATION_VALUE` Value used to enable indication for a client configuration descriptor
`public static final byte[]`	`ENABLE_NOTIFICATION_VALUE` Value used to enable notification for a client configuration descriptor

Public constructors
`BluetoothGattDescriptor(UUID uuid, int permissions)` Create a new BluetoothGattDescriptor.

Public methods
`BluetoothGattCharacteristic`	`getCharacteristic()` Returns the characteristic this descriptor belongs to.
`int`	`getPermissions()` Returns the permissions for this descriptor.
`UUID`	`getUuid()` Returns the UUID of this descriptor.
`byte[]`	`getValue()` Returns the stored value for this descriptor This function returns the stored value for this descriptor as retrieved by calling `readDescriptor(BluetoothGattDescriptor)`.
`boolean`	`setValue(byte[] value)` Updates the locally stored value of this descriptor.
`void`	`writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface android.os.Parcelable

Constants

PERMISSION_READ

Added in API level 18

int PERMISSION_READ

Descriptor read permission

Constant Value: 1 (0x00000001)

PERMISSION_READ_ENCRYPTED

Added in API level 18

int PERMISSION_READ_ENCRYPTED

Descriptor permission: Allow encrypted read operations

Constant Value: 2 (0x00000002)

PERMISSION_READ_ENCRYPTED_MITM

Added in API level 18

int PERMISSION_READ_ENCRYPTED_MITM

Descriptor permission: Allow reading with man-in-the-middle protection

Constant Value: 4 (0x00000004)

PERMISSION_WRITE

Added in API level 18

int PERMISSION_WRITE

Descriptor write permission

Constant Value: 16 (0x00000010)

PERMISSION_WRITE_ENCRYPTED

Added in API level 18

int PERMISSION_WRITE_ENCRYPTED

Descriptor permission: Allow encrypted writes

Constant Value: 32 (0x00000020)

PERMISSION_WRITE_ENCRYPTED_MITM

Added in API level 18

int PERMISSION_WRITE_ENCRYPTED_MITM

Descriptor permission: Allow encrypted writes with man-in-the-middle protection

Constant Value: 64 (0x00000040)

PERMISSION_WRITE_SIGNED

Added in API level 18

int PERMISSION_WRITE_SIGNED

Descriptor permission: Allow signed write operations

Constant Value: 128 (0x00000080)

PERMISSION_WRITE_SIGNED_MITM

Added in API level 18

int PERMISSION_WRITE_SIGNED_MITM

Descriptor permission: Allow signed write operations with man-in-the-middle protection

Constant Value: 256 (0x00000100)

Fields

CREATOR

Added in API level 24

Creator<BluetoothGattDescriptor> CREATOR

DISABLE_NOTIFICATION_VALUE

Added in API level 18

byte[] DISABLE_NOTIFICATION_VALUE

Value used to disable notifications or indicatinos

ENABLE_INDICATION_VALUE

Added in API level 18

byte[] ENABLE_INDICATION_VALUE

Value used to enable indication for a client configuration descriptor

ENABLE_NOTIFICATION_VALUE

Added in API level 18

byte[] ENABLE_NOTIFICATION_VALUE

Value used to enable notification for a client configuration descriptor

Public constructors

BluetoothGattDescriptor

Added in API level 18

BluetoothGattDescriptor (UUID uuid, 
                int permissions)

Create a new BluetoothGattDescriptor.

Requires BLUETOOTH permission.

Parameters
`uuid`	`UUID`: The UUID for this descriptor
`permissions`	`int`: Permissions for this descriptor

Public methods

getCharacteristic

Added in API level 18

BluetoothGattCharacteristic getCharacteristic ()

Returns the characteristic this descriptor belongs to.

Returns
`BluetoothGattCharacteristic`	The characteristic.

getPermissions

Added in API level 18

int getPermissions ()

Returns the permissions for this descriptor.

Returns
`int`	Permissions of this descriptor

getUuid

Added in API level 18

UUID getUuid ()

Returns the UUID of this descriptor.

Returns
`UUID`	UUID of this descriptor

getValue

Added in API level 18

byte[] getValue ()

Returns the stored value for this descriptor

This function returns the stored value for this descriptor as retrieved by calling readDescriptor(BluetoothGattDescriptor). The cached value of the descriptor is updated as a result of a descriptor read operation.

Returns
`byte[]`	Cached value of the descriptor

setValue

Added in API level 18

boolean setValue (byte[] value)

Updates the locally stored value of this descriptor.

This function modifies the locally stored cached value of this descriptor. To send the value to the remote device, call writeDescriptor(BluetoothGattDescriptor) to send the value to the remote device.

Parameters
`value`	`byte`: New value for this descriptor

Returns
`boolean`	true if the locally stored value has been set, false if the requested value could not be stored locally.

writeToParcel

Added in API level 24

void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`out`	`Parcel`: The Parcel in which the object should be written.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`.