org.bluez.obex.Client1 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.*;
import org.freedesktop.dbus.DBusPath;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.Variant;

import java.util.Map;

/**
 * File generated - 2023-02-20.

 * Based on bluez Documentation: obex-api.txt.

 * 

 * Service: org.bluez.obex

 * Interface: org.bluez.obex.Client1

 * 

 * Object path:

 *             /org/bluez/obex

 * 

 */
public interface Client1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * Create a new OBEX session for the given remote address.

     * 

     * The last parameter is a dictionary to hold optional or

     * type-specific parameters. Typical parameters that can

     * be set in this dictionary include the following:

     * 

     * 	string "Target" : type of session to be created

     * 	string "Source" : local address to be used

     * 	byte "Channel"

     * 

     * The currently supported targets are the following:

     * 

     * 	"ftp"

     * 	"map"

     * 	"opp"

     * 	"pbap"

     * 	"sync"

     * 

     * 
     * @param _destination destination
     * @param _args args
     * 
     * @return DBusPath - maybe null
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezFailedException on failure
     */
    DBusPath CreateSession(String _destination, Map> _args) throws BluezInvalidArgumentsException, BluezFailedException;

    /**
     * From bluez documentation:

     * 

     * Unregister session and abort pending transfers.

     * 

     * 
     * @param _session session
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezNotAuthorizedException when not authorized
     */
    void RemoveSession(DBusPath _session) throws BluezInvalidArgumentsException, BluezNotAuthorizedException;

}