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 Show documentation
Java native bluetooth library which uses bluez via dbus (linux only)
There is a newer version: 0.3.0
package org.bluez;

import java.util.Map;

import org.bluez.exceptions.BluezFailedException;
import org.bluez.exceptions.BluezInProgressException;
import org.bluez.exceptions.BluezInvalidValueLengthException;
import org.bluez.exceptions.BluezNotAuthorizedException;
import org.bluez.exceptions.BluezNotPermittedException;
import org.bluez.exceptions.BluezNotSupportedException;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.interfaces.Properties;
import org.freedesktop.dbus.types.Variant;

/**
 * File generated - 2018-07-25.

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

 * 

 * 

 */
public interface GattDescriptor1 extends DBusInterface, Properties {

    /**
     * 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
     * 
     * @throws BluezFailedException on failure
     * @throws BluezInProgressException when operation already in progress
     * @throws 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
     * @param _flags
     * 
     * @throws BluezFailedException on failure
     * @throws BluezInProgressException when operation already in progress
     * @throws BluezNotPermittedException
     * @throws 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;

}