Package org.bluez

Interface AgentManager1

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

Service: org.bluez
Interface: org.bluez.AgentManager1

Object path:
/org/bluez

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    RegisterAgent(org.freedesktop.dbus.DBusPath _agent, String _capability)
    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.
    void
    RequestDefaultAgent(org.freedesktop.dbus.DBusPath _agent)
    From bluez documentation:

    This requests is to make the application agent
    the default agent.
    void
    UnregisterAgent(org.freedesktop.dbus.DBusPath _agent)
    From bluez documentation:

    This unregisters the agent that has been previously
    registered.

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

    getObjectPath, isRemote

  • Method Details

    • RegisterAgent

      void RegisterAgent(org.freedesktop.dbus.DBusPath _agent, String _capability) throws BluezInvalidArgumentsException, BluezAlreadyExistsException
      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".

      Parameters:
      _agent - agent
      _capability - capability
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezAlreadyExistsException - when item already exists

    • UnregisterAgent

      void UnregisterAgent(org.freedesktop.dbus.DBusPath _agent) throws BluezDoesNotExistException
      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.

      Parameters:
      _agent - agent
      Throws:
      BluezDoesNotExistException - when item does not exist

    • RequestDefaultAgent

      void RequestDefaultAgent(org.freedesktop.dbus.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.

      Parameters:
      _agent - agent
      Throws:
      BluezDoesNotExistException - when item does not exist