org.bluez.AgentManager1 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.BluezAlreadyExistsException;
import org.bluez.exceptions.BluezDoesNotExistException;
import org.bluez.exceptions.BluezInvalidArgumentsException;
import org.freedesktop.dbus.DBusPath;
import org.freedesktop.dbus.interfaces.DBusInterface;
/**
* File generated - 2020-06-18.
* Based on bluez Documentation: agent-api.txt.
*
* Service: org.bluez
* Interface: org.bluez.AgentManager1
*
* Object path:
* /org/bluez
*
*/
public interface AgentManager1 extends DBusInterface {
/**
* From bluez documentation:
*
* This registers an agent handler.
*
* The object path defines the path of the agent
* that will be called when user input is needed.
*
* Every application can register its own agent and
* for all actions triggered by that application its
* agent is used.
*
* It is not required by an application to register
* an agent. If an application does chooses to not
* register an agent, the default agent is used. This
* is on most cases a good idea. Only application
* like a pairing wizard should register their own
* agent.
*
* An application can only register one agent. Multiple
* agents per application is not supported.
*
* The capability parameter can have the values
* "DisplayOnly", "DisplayYesNo", "KeyboardOnly",
* "NoInputNoOutput" and "KeyboardDisplay" which
* reflects the input and output capabilities of the
* agent.
*
* If an empty string is used it will fallback to
* "KeyboardDisplay".
*
*
* @param _agent agent
* @param _capability capability
*
* @throws BluezInvalidArgumentsException when argument is invalid
* @throws BluezAlreadyExistsException when item already exists
*/
void RegisterAgent(DBusPath _agent, String _capability) throws BluezInvalidArgumentsException, BluezAlreadyExistsException;
/**
* From bluez documentation:
*
* This unregisters the agent that has been previously
* registered. The object path parameter must match the
* same value that has been used on registration.
*
*
* @param _agent agent
*
* @throws BluezDoesNotExistException when item does not exist
*/
void UnregisterAgent(DBusPath _agent) throws BluezDoesNotExistException;
/**
* From bluez documentation:
*
* This requests is to make the application agent
* the default agent. The application is required
* to register an agent.
*
* Special permission might be required to become
* the default agent.
*
*
* @param _agent agent
*
* @throws BluezDoesNotExistException when item does not exist
*/
void RequestDefaultAgent(DBusPath _agent) throws BluezDoesNotExistException;
}