D-Bus интерфейс obex.PhonebookAccess1

Интерфейс позволяет управлять телефонной книгой.

Шина:	системная
Служба:	org.bluez.obex
Объект:	[путь к объекту сеанса]
Интерфейс:	org.bluez.obex.PhonebookAccess1

Cвойства

• DatabaseIdentifier : string [только для чтения, опционально]
• FixedImageSize : boolean [только для чтения, опционально]
• Folder : string [только для чтения]
• PrimaryCounter : string [только для чтения, опционально]
• SecondaryCounter : string [только для чтения, опционально]

Методы

• uint16 GetSize()
• array{string vcard, string name} List(dict filters)
• array{string} ListFilterFields()
• object, dict Pull(string vcard, string targetfile, dict filters)
• object, dict PullAll(string targetfile, dict filters)
• array{string vcard, string name} Search(string field, string value, dict filters)
• Select(string location, string phonebook)
• UpdateVersion()

Подробное описание

Интерфейс содержит свойства и методы для управления телефонной книгой. Методы List(), Pull() и Search() позволяют отсеивать элементы с помощью следующих фильтров:

string Format

Элементы в формате vcard. Возможные значения: vcard21 (по умолчанию) или vcard30.

string Order

Порядое элементов. Возможные значения: indexed (по умолчанию), alphanumeric или phonetic.

uint16 Offset

Смещение первого элемента, по умолчанию 0.

uint16 MaxCount

Максимальное количество элементов, по умолчанию не ограничено (65535).

array{string} Fields

Поля элемента vcard, по умолчанию выбраны все значения. Возможные значения можно запросить с помощью ListFilterFields().

array{string} FilterAll

Фильтрация элементов по полям с использованием логики И. Она не может использоваться вместе с FilterAny. Возможные значения можно запросить с помощью ListFilterFields().

array{string} FilterAny

Фильтрация элементов по полям с использованием логики ИЛИ. Она не может использоваться вместе с FilterAll. Возможные значения можно запросить с помощью ListFilterFields().

bool ResetNewMissedCalls

Сбрасывание новых элементов пропущенных вызовов. Фильтр можно использовать только для папок mch и cch.

Описание свойств

DatabaseIdentifier : string [только для чтения, опционально]

128-битный постоянный идентификатор базы данных.

Возможные значения: 32-значное шестнадцатеричное число, например A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6.

FixedImageSize : boolean [только для чтения, опционально]

Поддержка фиксированного размера изображения.

Возможные значения: True, если изображение в формате JPEG 300x300 пикселей, в противном случае False.

Folder : string [только для чтения]

Текущий каталог.

PrimaryCounter : string [только для чтения, опционально]

128-битный счётчик основной версии.

Возможные значения: 32-значное шестнадцатеричное число, например A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6.

SecondaryCounter : string [только для чтения, опционально]

128-битный счетчик дополнительной версии.

Возможные значения: 32-значное шестнадцатеричное число, например A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6.

Описание методов

uint16 GetSize()

Возвращает количество записей в выбранном объекте телефонной книги, которые фактически используются (т. е. индексы, соответствующие ненулевым записям).

Возможные ошибки:

• org.bluez.obex.Error.Forbidden,
• org.bluez.obex.Error.Failed.

array{string vcard, string name} List(dict filters)

Возвращает массив данных vcard-listing, где каждая запись состоит из пары строк, содержащих дескриптор vcard и имя контакта. Например: 1.vcf : Джон.

Возможные фильтры: Order, Offset и MaxCount.

Возможные ошибки:

• org.bluez.obex.Error.InvalidArguments,
• org.bluez.obex.Forbidden.

array{string} ListFilterFields()

Возвращает все доступные поля, которые можно использовать в фильтре.

Нет возможных ошибок.

object, dict Pull(string vcard, string targetfile, dict filters)

Получив дескриптор vcard, извлекает vcard из текущего объекта телефонной книги и сохраняет его в локальном файле.

Если указан пустой целевой файл, для временного файла будет автоматически сгенерировано имя.

Возвращаемый путь представляет вновь созданную передачу, которую следует использовать, чтобы узнать, был ли контент успешно передан или операция не удалась.

Свойства этой передачи также возвращаются вместе с путём к объекту, чтобы избежать вызова GetProperties.

Возможные фильтры: Format и Fields.

Возможные ошибки:

• org.bluez.obex.Error.InvalidArguments,
• org.bluez.obex.Error.Forbidden,
• org.bluez.obex.Error.Failed.

object, dict PullAll(string targetfile, dict filters)

Возвращает весь объект телефонной книги с сервера PSE в виде простой строки в формате vcard и сохраняет его в локальном файле.

Если указан пустой целевой файл, для временного файла будет автоматически сгенерировано имя.

Возвращаемый путь представляет вновь созданную передачу, которую следует использовать, чтобы узнать, был ли контент успешно передан или операция не удалась.

Свойства этой передачи также возвращаются вместе с путём к объекту, чтобы избежать вызова GetProperties.

Возможные фильтры: Format, Order, Offset, MaxCount и Fields.

Возможные ошибки:

• org.bluez.obex.Error.InvalidArguments,
• org.bluez.obex.Forbidden.

array{string vcard, string name} Search(string field, string value, dict filters)

Ищет записи, соответствующие заданному условию, и возвращает словарь данных vcard, где каждая запись состоит из пары строк, содержащих дескриптор vcard и имя контакта.

vcard

соответствующая name соответствует условию поиска. field

поле в vcard для поиска { name (по умолчанию) | number | sound }. value

строковое значение для поиска.

Возможные фильтры: Order, Offset и MaxCount.

Возможные ошибки:

• org.bluez.obex.Error.InvalidArguments,
• org.bluez.obex.Error.Forbidden,
• org.bluez.obex.Error.Failed.

Select(string location, string phonebook)

Выбирает объект телефонной книги для других операций. Должен вызываться перед всеми остальными операциями.

location

Где хранится телефонная книга, возможные значения: int (internal по умолчанию), sim (sim1), sim2, ... phonebook

Возможные значения:

• pb: телефонная книга для сохранённых контактов;
• ich: история входящих вызовов;
• och: история исходящих вызовов;
• mch: отсутствует история вызовов;
• cch: комбинация ich, och, mch;
• spd: ввод быстрого набора (только для internal);
• fav: запись в избранном (только для internal).

Возможные ошибки:

• org.bluez.obex.Error.InvalidArguments,
• org.bluez.obex.Error.Failed.

UpdateVersion()

Пробует обновить PrimaryCounter и SecondaryCounter.

Возможные ошибки:

• org.bluez.obex.Error.NotSupported,
• org.bluez.obex.Error.Forbidden,
• org.bluez.obex.Error.Failed.