Package org.bluez

Interface GattDescriptor1

All Superinterfaces:
org.freedesktop.dbus.interfaces.DBusInterface
public interface GattDescriptor1 extends org.freedesktop.dbus.interfaces.DBusInterface
File generated - 2023-02-20.
Based on bluez Documentation: gatt-api.txt.

Service: org.bluez
Interface: org.bluez.GattDescriptor1

Object path:
[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/serviceXX/charYYYY/descriptorZZZ

Supported properties:

string UUID [read-only]

128-bit descriptor UUID.

object Characteristic [read-only]

Object path of the GATT characteristic the descriptor
belongs to.

array{byte} Value [read-only, optional]

The cached value of the descriptor. This property
gets updated only after a successful read request, upon
which a PropertiesChanged signal will be emitted.

array{string} Flags [read-only]

Defines how the descriptor value can be used.

Possible values:

"read"
"write"
"encrypt-read"
"encrypt-write"
"encrypt-authenticated-read"
"encrypt-authenticated-write"
"secure-read" (Server Only)
"secure-write" (Server Only)
"authorize"

uint16 Handle [read-write, optional] (Server Only)

Characteristic handle. When available in the server it
would attempt to use to allocate into the database
which may fail, to auto allocate the value 0x0000
shall be used which will cause the allocated handle to
be set once registered.


  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    ReadValue(Map<String,org.freedesktop.dbus.types.Variant<?>> _flags)
    From bluez documentation:

    Issues a request to read the value of the
    characteristic and returns the value if the
    operation was successful.

    Possible options: "offset": Start offset
    "device": Device path (Server only)
    "link": Link type (Server only)

    void
    WriteValue(byte[] _value, Map<String,org.freedesktop.dbus.types.Variant<?>> _flags)
    From bluez documentation:

    Issues a request to write the value of the
    characteristic.

    Possible options: "offset": Start offset
    "device": Device path (Server only)
    "link": Link type (Server only)
    "prepare-authorize": boolean Is prepare
    authorization
    request

    Methods inherited from interface org.freedesktop.dbus.interfaces.DBusInterface

    getObjectPath, isRemote