org.bluez.obex.Agent1 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bluez-dbus-osgi Show documentation

Java native bluetooth library which uses bluez via dbus (linux only). This is the OSGi compliant bundle of all required libraries in one bundle.

The newest version!

package org.bluez.obex;

import org.bluez.exceptions.BluezCanceledException;
import org.bluez.exceptions.BluezRejectedException;
import org.freedesktop.dbus.DBusPath;
import 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

 * 

 */
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 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.

     * 

     * 
     * @param _transfer transfer
     * 
     * @return String - maybe null
     * 
     * @throws BluezRejectedException when operation rejected
     * @throws BluezCanceledException when operation canceled
     */
    String AuthorizePush(DBusPath _transfer) throws BluezRejectedException, BluezCanceledException;

    /**
     * From bluez documentation:

     * 

     * This method gets called to indicate that the agent

     * request failed before a reply was returned. It cancels

     * the previous request.

     */
    void Cancel();

}