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

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

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

Методы

array{string} ListFilterFields()
array{dict} ListFolders(dict filter)
array{object, dict} ListMessages(string folder, dict filter)
object, dict PushMessage(string sourcefile, string folder, dict args)
SetFolder(string name)
UpdateInbox()

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

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

uint16 Offset: Смещение первого элемента, по умолчанию 0.
uint16 MaxCount: Максимальное количество элементов, по умолчанию 1024.
byte SubjectLength: Максимальная длина свойства Subject в сообщении, по умолчанию 256.
array{string} Fields: Поля сообщений, по умолчанию выбраны все значения. Возможные значения можно запросить с помощью ListFilterFields().
array{string} Types: Фильтровать сообщения по типу. Возможные значения: sms, email, mms.
string PeriodBegin: Фильтровать сообщения по дате начала. Возможные значения: дата в формате YYYYMMDDTHHMMSS.
string PeriodEnd: Фильтровать сообщения по дате окончания. Возможные значения: дата в формате YYYYMMDDTHHMMSS.
boolean Read: Фильтровать сообщения по флагу прочтения. Возможные значения: True для прочитанного или False для непрочитанного.
string Recipient: Фильтровать сообщения по адресу получателя.
string Sender: Фильтровать сообщения по адресу отправителя.
boolean Priority: Фильтровать сообщения по флагу приоритета. Возможные значения: True для высокого приоритета или False для низкого приоритета.

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

array{string} ListFilterFields()

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

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

array{dict} ListFolders(dict filter)

Возвращает словарь, содержащий информацию о содержимом текущего каталога.

Определены следующие ключи:

string Name: Имя каталога.

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

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

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

array{object, dict} ListMessages(string folder, dict filter)

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

Возможные фильтры: Offset, MaxCount, SubjectLength, Fields, Type, PeriodStart, PeriodEnd, Status, Recipient, Sender, Priority.

Каждое сообщение представлено путём к объекту, за которым следует словарь свойств.

Свойства:

string Subject: Тема сообщения.
string Timestamp: Отметка времени сообщения.
string Sender: Имя отправителя сообщения.
string SenderAddress: Адрес отправителя сообщения.
string ReplyTo: Адрес для ответа на сообщение.
string Recipient: Имя получателя сообщения.
string RecipientAddress: Адрес получателя сообщения.
string Type: Тип сообщения. Возможные значения: email, sms-gsm, sms-cdma и mms
uint64 Size: Размер сообщения в байтах.
boolean Text: Флаг текста сообщения указывает, имеет ли сообщение текстовое содержимое или только двоичное.
string Status: Статус сообщения. Возможные значения для полученных сообщений: complete, fractioned, notification. Возможные значения для отправленных сообщений: delivery-success, sending-success,delivery-failure, sending-failure.
uint64 AttachmentSize: Общий размер вложения сообщения в байтах.
boolean Priority: Флаг приоритета сообщения.
boolean Read: Флаг чтения сообщения.
boolean Sent: Флаг отправленного сообщения.
boolean Protected: Флаг защищённого сообщения.

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

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

object, dict PushMessage(string sourcefile, string folder, dict args)

Передаёт сообщение (в формате bMessage) на удалённое устройство.

Сообщение переносится либо в заданный подкаталог текущего каталога, либо в текущий каталог, если он пуст.

Возможные args: Transparent, Retry, Charset.

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

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

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

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

SetFolder(string name)

Устанавливает рабочий каталог для текущего сеанса, name может быть именем каталога или '..[/dir]'.

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

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

UpdateInbox()

Запрашивает удалённое обновление почтового ящика.

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

org.bluez.obex.Error.Failed.