org.bluez.obex.MessageAccess - BlueZ D-Bus OBEX MessageAccess API documentation

Service org.bluez.obex Interface org.bluez.obex.MessageAccess1 Objectpath [Session object path] MethodsvoidSetFolder(stringname) Set working directory for current session. Possible name: Directory name or '..[/dir]'. Possible errors: org.bluez.obex.Error.InvalidArgumentsorg.bluez.obex.Error.Failedarray{dict}ListFolders(dictfilter) Returns a dictionary containing information about the current folder content. Possible filter: uint16Offset(default0) Offset of the first item. uint16MaxCount(default1024) Maximum number of items. Possible return: stringName Folder name Possible errors: org.bluez.obex.Error.InvalidArgumentsorg.bluez.obex.Error.Failedarray{string}ListFilterFields() Return all available fields that can be used in Fields filter. Possible values: "subject""timestamp""sender""sender-address""recipient""recipient-address""type""size""status""text""attachment""priority""read""sent""protected""replyto" Possible errors: None array{object,dict}ListMessages(stringfolder,dictfilter) Returns an array containing the messages objects found in the given subfolder of the current folder, or in the current folder if folder is empty. Possible Filters: uint16Offset(default0) Offset of the first item. uint16 MaxCount (default 1024): Maximum number of items. byteSubjectLength(default256) Maximum length of the Subject property in the message. array{string}Fields Message fields, default is all values. See ListFilterFields() for possible values. array{string}Types Filter messages by type. Possible values: "sms""email""mms"stringPeriodBegin Filter messages by starting period. Possible values: Date in "YYYYMMDDTHHMMSS" format. stringPeriodEnd Filter messages by ending period. Possible values: Date in "YYYYMMDDTHHMMSS" format. booleanRead Filter messages by read flag. Possible values: True for read or False for unread stringRecipient Filter messages by recipient address. stringSender Filter messages by sender address. booleanPriority Filter messages by priority flag. Possible values: True for high priority or False for non-high priority. Each message is represented by an object path, which implements org.bluez.obex.Message(5) interface, followed by a dictionary of its properties. void UpdateInbox(void) Requests remote to update its inbox. Possible errors: org.bluez.obex.Error.Failedobject,dictPushMessage(stringsourcefile,stringfolder,dictargs) Transfers a message (in bMessage format) to the remote device. The message is transferred either to the given subfolder of the current folder, or to the current folder if folder is empty. Possible args: Transparent, Retry, Charset 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, see org.bluez.obex.Transfer(5) for the possible list of properties. Possible errors: org.bluez.obex.Error.InvalidArgumentsorg.bluez.obex.Error.FailedPropertiesarray{string}SupportedTypes[readonly] List of supported message types. Possible values: "EMAIL" Email messages. "SMS_GSM" GSM short messages. "SMS_CDMA" CDMA short messages. "MMS" MMS messages. "IM" Instant messaging. BlueZ October 2023 ORG.BLUEZ.OBEX.MESSAGEACCESS(5)

org.bluez.obex.MessageAccess - BlueZ D-Bus OBEX MessageAccess API documentation