Package org.bluez

Interface Agent1

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

Service: unique name
Interface: org.bluez.Agent1

Object path:
freely definable

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    AuthorizeService(org.freedesktop.dbus.DBusPath _device, String _uuid)
    From bluez documentation:

    This method gets called when the service daemon
    needs to authorize a connection/service request.

    void
    Cancel()
    From bluez documentation:

    This method gets called to indicate that the agent
    request failed before a reply was returned.
    void
    DisplayPasskey(org.freedesktop.dbus.DBusPath _device, org.freedesktop.dbus.types.UInt32 _passkey, org.freedesktop.dbus.types.UInt16 _entered)
    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.
    void
    DisplayPinCode(org.freedesktop.dbus.DBusPath _device, String _pincode)
    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.
    void
    Release()
    From bluez documentation:

    This method gets called when the service daemon
    unregisters the agent.
    void
    RequestAuthorization(org.freedesktop.dbus.DBusPath _device)
    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.
    void
    RequestConfirmation(org.freedesktop.dbus.DBusPath _device, org.freedesktop.dbus.types.UInt32 _passkey)
    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.

    org.freedesktop.dbus.types.UInt32
    RequestPasskey(org.freedesktop.dbus.DBusPath _device)
    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.

    String
    RequestPinCode(org.freedesktop.dbus.DBusPath _device)
    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.

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

    getObjectPath, isRemote

  • Method Details

    • Release

      void Release()
      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.

    • RequestPinCode

      String RequestPinCode(org.freedesktop.dbus.DBusPath _device) 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 string of 1-16 characters
      length. The string can be alphanumeric.

      Parameters:
      _device - device
      Returns:
      String - maybe null
      Throws:
      BluezRejectedException - when operation rejected
      BluezCanceledException - when operation canceled

    • DisplayPinCode

      void DisplayPinCode(org.freedesktop.dbus.DBusPath _device, String _pincode) 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.

      Parameters:
      _device - device
      _pincode - pincode
      Throws:
      BluezRejectedException - when operation rejected
      BluezCanceledException - when operation canceled

    • RequestPasskey

      org.freedesktop.dbus.types.UInt32 RequestPasskey(org.freedesktop.dbus.DBusPath _device) 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.

      Parameters:
      _device - device
      Returns:
      UInt32 - maybe null
      Throws:
      BluezRejectedException - when operation rejected
      BluezCanceledException - when operation canceled

    • DisplayPasskey

      void DisplayPasskey(org.freedesktop.dbus.DBusPath _device, org.freedesktop.dbus.types.UInt32 _passkey, org.freedesktop.dbus.types.UInt16 _entered)
      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.

      Parameters:
      _device - device
      _passkey - passkey
      _entered - entered

    • RequestConfirmation

      void RequestConfirmation(org.freedesktop.dbus.DBusPath _device, org.freedesktop.dbus.types.UInt32 _passkey) throws BluezRejectedException, BluezCanceledException
      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.

      Parameters:
      _device - device
      _passkey - passkey
      Throws:
      BluezRejectedException - when operation rejected
      BluezCanceledException - when operation canceled

    • RequestAuthorization

      void RequestAuthorization(org.freedesktop.dbus.DBusPath _device) 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.

      Parameters:
      _device - device
      Throws:
      BluezRejectedException - when operation rejected
      BluezCanceledException - when operation canceled

    • AuthorizeService

      void AuthorizeService(org.freedesktop.dbus.DBusPath _device, String _uuid) throws BluezRejectedException, BluezCanceledException
      From bluez documentation:

      This method gets called when the service daemon
      needs to authorize a connection/service request.

      Parameters:
      _device - device
      _uuid - uuid
      Throws:
      BluezRejectedException - when operation rejected
      BluezCanceledException - when operation canceled

    • Cancel

      void Cancel()
      From bluez documentation:

      This method gets called to indicate that the agent
      request failed before a reply was returned.