Package org.bluez.obex

Interface Agent1

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

Service: unique name
Interface: org.bluez.obex.Agent1

Object path:
freely definable

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    AuthorizePush(org.freedesktop.dbus.DBusPath _transfer)
    From bluez documentation:

    This method gets called when the service daemon
    needs to accept/reject a Bluetooth object push request.

    Returns the full path (including the filename) where
    the object shall be stored.
    void
    Cancel()
    From bluez documentation:

    This method gets called to indicate that the agent
    request failed before a reply was returned.
    void
    Release()
    From bluez documentation:

    This method gets called when the service daemon
    unregisters the agent.

    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.

    • AuthorizePush

      String AuthorizePush(org.freedesktop.dbus.DBusPath _transfer) throws BluezRejectedException, BluezCanceledException
      From bluez documentation:

      This method gets called when the service daemon
      needs to accept/reject a Bluetooth object push request.

      Returns the full path (including the filename) where
      the object shall be stored. The tranfer object will
      contain a Filename property that contains the default
      location and name that can be returned.

      Parameters:
      _transfer - transfer
      Returns:
      String - maybe null
      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. It cancels
      the previous request.