org.bluez.Agent1 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
Show all versions of bluez-dbus Show documentation
Java native bluetooth library which uses bluez via dbus (linux only)
package org.bluez;
import org.bluez.exceptions.BluezCanceledException;
import org.bluez.exceptions.BluezRejectedException;
import org.freedesktop.dbus.DBusPath;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.UInt16;
import org.freedesktop.dbus.types.UInt32;
/**
* File generated - 2020-06-18.
* Based on bluez Documentation: agent-api.txt.
*
* Service: unique name
* Interface: org.bluez.Agent1
*
* Object path:
* freely definable
*
*/
public interface Agent1 extends DBusInterface {
/**
* From bluez documentation:
*
* This method gets called when the service daemon
* unregisters the agent. An agent can use it to do
* cleanup tasks. There is no need to unregister the
* agent, because when this method gets called it has
* already been unregistered.
*
*/
void Release();
/**
* From bluez documentation:
*
* This method gets called when the service daemon
* needs to get the passkey for an authentication.
*
* The return value should be a string of 1-16 characters
* length. The string can be alphanumeric.
*
*
* @param _device device
*
* @return String - maybe null
*
* @throws BluezRejectedException when operation rejected
* @throws BluezCanceledException when operation canceled
*/
String RequestPinCode(DBusPath _device) throws BluezRejectedException, BluezCanceledException;
/**
* From bluez documentation:
*
* This method gets called when the service daemon
* needs to display a pincode for an authentication.
*
* An empty reply should be returned. When the pincode
* needs no longer to be displayed, the Cancel method
* of the agent will be called.
*
* This is used during the pairing process of keyboards
* that don't support Bluetooth 2.1 Secure Simple Pairing,
* in contrast to DisplayPasskey which is used for those
* that do.
*
* This method will only ever be called once since
* older keyboards do not support typing notification.
*
* Note that the PIN will always be a 6-digit number,
* zero-padded to 6 digits. This is for harmony with
* the later specification.
*
*
* @param _device device
* @param _pincode pincode
*
* @throws BluezRejectedException when operation rejected
* @throws BluezCanceledException when operation canceled
*/
void DisplayPinCode(DBusPath _device, String _pincode) throws BluezRejectedException, BluezCanceledException;
/**
* From bluez documentation:
*
* This method gets called when the service daemon
* needs to get the passkey for an authentication.
*
* The return value should be a numeric value
* between 0-999999.
*
*
* @param _device device
*
* @return UInt32 - maybe null
*
* @throws BluezRejectedException when operation rejected
* @throws BluezCanceledException when operation canceled
*/
UInt32 RequestPasskey(DBusPath _device) throws BluezRejectedException, BluezCanceledException;
/**
* From bluez documentation:
*
* This method gets called when the service daemon
* needs to display a passkey for an authentication.
*
* The entered parameter indicates the number of already
* typed keys on the remote side.
*
* An empty reply should be returned. When the passkey
* needs no longer to be displayed, the Cancel method
* of the agent will be called.
*
* During the pairing process this method might be
* called multiple times to update the entered value.
*
* Note that the passkey will always be a 6-digit number,
* so the display should be zero-padded at the start if
* the value contains less than 6 digits.
*
*
* @param _device device
* @param _passkey passkey
* @param _entered entered
*/
void DisplayPasskey(DBusPath _device, UInt32 _passkey, UInt16 _entered);
/**
* From bluez documentation:
*
* This method gets called when the service daemon
* needs to confirm a passkey for an authentication.
*
* To confirm the value it should return an empty reply
* or an error in case the passkey is invalid.
*
* Note that the passkey will always be a 6-digit number,
* so the display should be zero-padded at the start if
* the value contains less than 6 digits.
*
*
* @param _device device
* @param _passkey passkey
*
* @throws BluezRejectedException when operation rejected
* @throws BluezCanceledException when operation canceled
*/
void RequestConfirmation(DBusPath _device, UInt32 _passkey) throws BluezRejectedException, BluezCanceledException;
/**
* From bluez documentation:
*
* This method gets called to request the user to
* authorize an incoming pairing attempt which
* would in other circumstances trigger the just-works
* model, or when the user plugged in a device that
* implements cable pairing. In the latter case, the
* device would not be connected to the adapter via
* Bluetooth yet.
*
*
* @param _device device
*
* @throws BluezRejectedException when operation rejected
* @throws BluezCanceledException when operation canceled
*/
void RequestAuthorization(DBusPath _device) throws BluezRejectedException, BluezCanceledException;
/**
* From bluez documentation:
*
* This method gets called when the service daemon
* needs to authorize a connection/service request.
*
*
* @param _device device
* @param _uuid uuid
*
* @throws BluezRejectedException when operation rejected
* @throws BluezCanceledException when operation canceled
*/
void AuthorizeService(DBusPath _device, String _uuid) throws BluezRejectedException, BluezCanceledException;
/**
* From bluez documentation:
*
* This method gets called to indicate that the agent
* request failed before a reply was returned.
*/
void Cancel();
}