Package org.bluez.obex

Interface Synchronization1

All Superinterfaces:
org.freedesktop.dbus.interfaces.DBusInterface
public interface Synchronization1 extends org.freedesktop.dbus.interfaces.DBusInterface
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]

  • Method Summary

    Modifier and Type
    Method
    Description
    TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>>
    GetPhonebook(String _targetfile)
    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.

    TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>>
    PutPhonebook(String _sourcefile)
    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.

    void
    SetLocation(String _location)
    From bluez documentation:

    Set the phonebook object store location for other
    operations.

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

    getObjectPath, isRemote

  • Method Details

    • SetLocation

      void SetLocation(String _location) throws BluezInvalidArgumentsException
      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"
      ......

      Parameters:
      _location - location
      Throws:
      BluezInvalidArgumentsException - when argument is invalid

    • GetPhonebook

      TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>> GetPhonebook(String _targetfile) throws BluezInvalidArgumentsException, BluezFailedException
      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.

      Parameters:
      _targetfile - targetfile
      Returns:
      TwoTuple<DBusPath, Map<String,Variant<?>>> - maybe null
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezFailedException - on failure

    • PutPhonebook

      TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>> PutPhonebook(String _sourcefile) 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.

      Parameters:
      _sourcefile - sourcefile
      Returns:
      TwoTuple<DBusPath, Map<String,Variant<?>>> - maybe null
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezFailedException - on failure