org.bluez.obex.Synchronization1 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.datatypes.TwoTuple;
import org.bluez.exceptions.BluezFailedException;
import org.bluez.exceptions.BluezInvalidArgumentsException;
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.Synchronization1

 * 

 * Object path:

 *             [Session object path]

 * 

 */
public interface Synchronization1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * Set the phonebook object store location for other

     * operations. Should be called before all the other

     * operations.

     * 

     * location: Where the phonebook is stored, possible

     * values:

     * 	"int" ( "internal" which is default )

     * 	"sim1"

     * 	"sim2"

     * 	......

     * 

     * 
     * @param _location location
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     */
    void SetLocation(String _location) throws BluezInvalidArgumentsException;

    /**
     * From bluez documentation:

     * 

     * Retrieve an entire Phonebook Object store from remote

     * device, and stores it in a local file.

     * 

     * If an empty target file is given, a name will be

     * automatically calculated for the temporary file.

     * 

     * The returned path represents the newly created transfer,

     * which should be used to find out if the content has been

     * successfully transferred or if the operation fails.

     * 

     * The properties of this transfer are also returned along

     * with the object path, to avoid a call to GetProperties.

     * 

     * 
     * @param _targetfile targetfile
     * 
     * @return TwoTuple<DBusPath, Map<String,Variant<?>>> - maybe null
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezFailedException on failure
     */
    TwoTuple>> GetPhonebook(String _targetfile) throws BluezInvalidArgumentsException, BluezFailedException;

    /**
     * From bluez documentation:

     * 

     * Send an entire Phonebook Object store to remote device.

     * 

     * The returned path represents the newly created transfer,

     * which should be used to find out if the content has been

     * successfully transferred or if the operation fails.

     * 

     * The properties of this transfer are also returned along

     * with the object path, to avoid a call to GetProperties.

     * 

     * 
     * @param _sourcefile sourcefile
     * 
     * @return TwoTuple<DBusPath, Map<String,Variant<?>>> - maybe null
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezFailedException on failure
     */
    TwoTuple>> PutPhonebook(String _sourcefile) throws BluezInvalidArgumentsException, BluezFailedException;

}