org.bluez.GattDescriptor1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bluez-dbus-osgi Show documentation
Java native bluetooth library which uses bluez via dbus (linux only). This is the OSGi compliant bundle of all required libraries in one bundle.
The newest version!
package org.bluez;

import org.bluez.exceptions.*;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.Variant;

import java.util.Map;

/**
 * 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.

 * 

 * 

 */
public interface GattDescriptor1 extends DBusInterface {

    /**
     * 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)

     * 

     * 
     * @param _flags flags
     * 
     * @return byte[] - maybe null
     * 
     * @throws BluezFailedException on failure
     * @throws BluezInProgressException when operation already in progress
     * @throws BluezNotPermittedException on BluezNotPermittedException
     * @throws BluezNotAuthorizedException when not authorized
     * @throws BluezNotSupportedException when operation not supported
     */
    byte[] ReadValue(Map> _flags) throws BluezFailedException, BluezInProgressException, BluezNotPermittedException, BluezNotAuthorizedException, BluezNotSupportedException;

    /**
     * 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

     * 

     * 
     * @param _value value
     * @param _flags flags
     * 
     * @throws BluezFailedException on failure
     * @throws BluezInProgressException when operation already in progress
     * @throws BluezNotPermittedException on BluezNotPermittedException
     * @throws BluezInvalidValueLengthException on BluezInvalidValueLengthException
     * @throws BluezNotAuthorizedException when not authorized
     * @throws BluezNotSupportedException when operation not supported
     */
    void WriteValue(byte[] _value, Map> _flags) throws BluezFailedException, BluezInProgressException, BluezNotPermittedException, BluezInvalidValueLengthException, BluezNotAuthorizedException, BluezNotSupportedException;

}