Package org.bluez.obex

Interface PhonebookAccess1

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

Object path:
[Session object path]

Supported properties:

string Folder [readonly]

Current folder.

string DatabaseIdentifier [readonly, optional]

128 bits persistent database identifier.

Possible values: 32-character hexadecimal such
as A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6

string PrimaryCounter [readonly, optional]

128 bits primary version counter.

Possible values: 32-character hexadecimal such
as A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6

string SecondaryCounter [readonly, optional]

128 bits secondary version counter.

Possible values: 32-character hexadecimal such
as A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6

bool FixedImageSize [readonly, optional]

Indicate support for fixed image size.

Possible values: True if image is JPEG 300x300 pixels
otherwise False.


  • Method Summary

    Modifier and Type
    Method
    Description
    org.freedesktop.dbus.types.UInt16
    GetSize()
    From bluez documentation:

    Return the number of entries in the selected phonebook
    object that are actually used (i.e. indexes that
    correspond to non-NULL entries).

    TwoTuple<String,String>[]
    List(Map<String,org.freedesktop.dbus.types.Variant<?>> _filters)
    From bluez documentation:

    Return an array of vcard-listing data where every entry
    consists of a pair of strings containing the vcard
    handle and the contact name.
    String[]
    ListFilterFields()
    From bluez documentation:

    Return All Available fields that can be used in Fields
    filter.

    TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>>
    Pull(String _vcard, String _targetfile, Map<String,org.freedesktop.dbus.types.Variant<?>> _filters)
    From bluez documentation:

    Given a vcard handle, retrieve the vcard in the current
    phonebook object and store 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.

    Possbile filters: Format and Fields

    TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>>
    PullAll(String _targetfile, Map<String,org.freedesktop.dbus.types.Variant<?>> _filters)
    From bluez documentation:

    Return the entire phonebook object from the PSE server
    in plain string with vcard format, and store 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.

    Possible filters: Format, Order, Offset, MaxCount and
    Fields

    TwoTuple<String,String[]>
    Search(String _field, String _value, Map<String,org.freedesktop.dbus.types.Variant<?>> _filters)
    From bluez documentation:

    Search for entries matching the given condition and
    return an array of vcard-listing data where every entry
    consists of a pair of strings containing the vcard
    handle and the contact name.

    vcard : name paired string match the search condition.

    field : the field in the vcard to search with
    { "name" (default) | "number" | "sound" }
    value : the string value to search for


    Possible filters: Order, Offset and MaxCount

    void
    Select(String _location, String _phonebook)
    From bluez documentation:

    Select the phonebook object for other operations.
    void
    UpdateVersion()
    From bluez documentation:

    Attempt to update PrimaryCounter and SecondaryCounter.

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

    getObjectPath, isRemote

  • Method Details

    • Select

      void Select(String _location, String _phonebook) throws BluezInvalidArgumentsException, BluezFailedException
      From bluez documentation:

      Select the phonebook object for other operations. Should
      be call before all the other operations.

      location : Where the phonebook is stored, possible
      inputs :
      "int" ( "internal" which is default )
      "sim" ( "sim1" )
      "sim2"
      ...

      phonebook : Possible inputs :
      "pb" : phonebook for the saved contacts
      "ich": incoming call history
      "och": outgoing call history
      "mch": missing call history
      "cch": combination of ich och mch
      "spd": speed dials entry ( only for "internal" )
      "fav": favorites entry ( only for "internal" )

      Parameters:
      _location - location
      _phonebook - phonebook
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezFailedException - on failure

    • PullAll

      TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>> PullAll(String _targetfile, Map<String,org.freedesktop.dbus.types.Variant<?>> _filters) throws BluezInvalidArgumentsException, BluezForbiddenException
      From bluez documentation:

      Return the entire phonebook object from the PSE server
      in plain string with vcard format, and store 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.

      Possible filters: Format, Order, Offset, MaxCount and
      Fields

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

    • List

      TwoTuple<String,String>[] List(Map<String,org.freedesktop.dbus.types.Variant<?>> _filters) throws BluezInvalidArgumentsException, BluezForbiddenException
      From bluez documentation:

      Return an array of vcard-listing data where every entry
      consists of a pair of strings containing the vcard
      handle and the contact name. For example:
      "1.vcf" : "John"

      Possible filters: Order, Offset and MaxCount

      Parameters:
      _filters - filters
      Returns:
      TwoTuple<String, String>[] - maybe null
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezForbiddenException - on BluezForbiddenException

    • Pull

      TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>> Pull(String _vcard, String _targetfile, Map<String,org.freedesktop.dbus.types.Variant<?>> _filters) throws BluezInvalidArgumentsException, BluezForbiddenException, BluezFailedException
      From bluez documentation:

      Given a vcard handle, retrieve the vcard in the current
      phonebook object and store 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.

      Possbile filters: Format and Fields

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

    • Search

      TwoTuple<String,String[]> Search(String _field, String _value, Map<String,org.freedesktop.dbus.types.Variant<?>> _filters) throws BluezInvalidArgumentsException, BluezForbiddenException, BluezFailedException
      From bluez documentation:

      Search for entries matching the given condition and
      return an array of vcard-listing data where every entry
      consists of a pair of strings containing the vcard
      handle and the contact name.

      vcard : name paired string match the search condition.

      field : the field in the vcard to search with
      { "name" (default) | "number" | "sound" }
      value : the string value to search for


      Possible filters: Order, Offset and MaxCount

      Parameters:
      _field - field
      _value - value
      _filters - filters
      Returns:
      TwoTuple<String, String[]> - maybe null
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezForbiddenException - on BluezForbiddenException
      BluezFailedException - on failure

    • GetSize

      org.freedesktop.dbus.types.UInt16 GetSize() throws BluezForbiddenException, BluezFailedException
      From bluez documentation:

      Return the number of entries in the selected phonebook
      object that are actually used (i.e. indexes that
      correspond to non-NULL entries).

      Returns:
      UInt16 - maybe null
      Throws:
      BluezForbiddenException - on BluezForbiddenException
      BluezFailedException - on failure

    • UpdateVersion

      void UpdateVersion() throws BluezNotSupportedException, BluezForbiddenException, BluezFailedException
      From bluez documentation:

      Attempt to update PrimaryCounter and SecondaryCounter.

      Throws:
      BluezNotSupportedException - when operation not supported
      BluezForbiddenException - on BluezForbiddenException
      BluezFailedException - on failure

    • ListFilterFields

      String[] ListFilterFields()
      From bluez documentation:

      Return All Available fields that can be used in Fields
      filter.

      Returns:
      String[] - maybe null