From 57a12b257165f366e04f7a39b08586739e6d7646 Mon Sep 17 00:00:00 2001 From: Luiz Augusto von Dentz Date: Thu, 20 Dec 2012 20:40:42 +0200 Subject: [PATCH] obex-client: Rename org.bluez.obex.MessageAccess to MessageAccess1 Rename the interface and move it to obexd-api.txt since it now belongs to the same daemon, in addition do the same to org.bluez.obex.Message. --- doc/obex-client-api.txt | 250 ---------------------------------------- doc/obexd-api.txt | 249 +++++++++++++++++++++++++++++++++++++++ obexd/client/map.c | 4 +- 3 files changed, 251 insertions(+), 252 deletions(-) diff --git a/doc/obex-client-api.txt b/doc/obex-client-api.txt index dc92d6500..eec3fc9db 100644 --- a/doc/obex-client-api.txt +++ b/doc/obex-client-api.txt @@ -4,256 +4,6 @@ OBEX client API description Copyright (C) 2007-2010 Marcel Holtmann Copyright (C) 2011-2012 BMW Car IT GmbH. All rights reserved. -Message Access hierarchy -========================= - -Service org.bluez.obex -Interface org.bluez.obex.MessageAccess -Object path [variable prefix]/{session0,session1,...} - -Methods void SetFolder(string name) - - Set working directory for current session, *name* may - be the directory name or '..[/dir]'. - - array{dict} ListFolders(dict filter) - - Returns a dictionary containing information about - the current folder content. - - The following keys are defined: - - string Name : Folder name - - Possible filters: Offset and MaxCount - - array{string} ListFilterFields() - - Return all available fields that can be used in Fields - filter. - - array{object, dict} ListMessages(string folder, dict filter) - - Returns an array containing the messages found in the - given folder. - - Possible Filters: Offset, MaxCount, Fields, Type, - PeriodStart, PeriodEnd, Status, Recipient, Sender, - Priority - - Each message is represented by an object path followed - by a dictionary of the properties. - - Properties: - - string Subject: - - Message subject - - string Timestamp: - - Message timestamp - - string Sender: - - Message sender name - - string SenderAddress: - - Message sender address - - string ReplyTo: - - Message Reply-To address - - string Recipient: - - Message recipient name - - string RecipientAddress: - - Message recipient address - - string Type: - - Message type - - Possible values: "EMAIL", "SMS_GSM", - "SMS_CDMA" and "MMS" - - uint64 Size: - - Message size in bytes - - string Status: - - Message reception status - - Possible values: "complete", - "fractioned" and "notification" - - boolean Priority: - - Message priority flag - - boolean Read: - - Message read flag - - boolean Sent: - - Message sent flag - - boolean Protected: - - Message protected flag - - void UpdateInbox(void) - - Request remote to update its inbox. - - -Filter: uint16 Offset: - - Offset of the first item, default is 0 - - uint16 MaxCount: - - Maximum number of items, default is 1024 - - array{string} Fields: - - Message fields, default is all values. - - Possible values can be query with ListFilterFields. - - array{string} Types: - - Filter messages by type. - - Possible values: "sms", "email", "mms". - - string PeriodBegin: - - Filter messages by starting period. - - Possible values: Date in "YYYYMMDDTHHMMSS" format. - - string PeriodEnd: - - Filter messages by ending period. - - Possible values: Date in "YYYYMMDDTHHMMSS" format. - - boolean Read: - - Filter messages by read flag. - - Possible values: True for read or False for unread - - string Recipient: - - Filter messages by recipient address. - - string Sender: - - Filter messages by sender address. - - gboolean Priority: - - Filter messages by priority flag. - - Possible values: True for high priority or False for - non-high priority - -Message hierarchy -================= - -Service org.bluez.obex -Interface org.bluez.obex.Message -Object path [variable prefix]/{session0,session1,...}/{message0,...} - -Methods object, dict Get(string targetfile, boolean attachment) - - Download message and store it in the target file. - - If an empty target file is given, a temporary file - will be automatically generated. - - 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. - -Properties string Subject [readonly] - - Message subject - - string Timestamp [readonly] - - Message timestamp - - string Sender [readonly] - - Message sender name - - string SenderAddress [readonly] - - Message sender address - - string ReplyTo [readonly] - - Message Reply-To address - - string Recipient [readonly] - - Message recipient name - - string RecipientAddress [readonly] - - Message recipient address - - string Type [readonly] - - Message type - - Possible values: "EMAIL", "SMS_GSM", - "SMS_CDMA" and "MMS" - - uint64 Size [readonly] - - Message size in bytes - - string Status [readonly] - - Message reception status - - Possible values: "complete", - "fractioned" and "notification" - - boolean Priority [readonly] - - Message priority flag - - boolean Read [read/write] - - Message read flag - - boolean Deleted [writeonly] - - Message read flag - - boolean Sent [readonly] - - Message sent flag - - boolean Protected [readonly] - - Message protected flag - - Transfer hierarchy ================== diff --git a/doc/obexd-api.txt b/doc/obexd-api.txt index 1b4c250d8..f43fb122f 100644 --- a/doc/obexd-api.txt +++ b/doc/obexd-api.txt @@ -423,3 +423,252 @@ Methods void SetLocation(string location) The properties of this transfer are also returned along with the object path, to avoid a call to GetProperties. + +Message Access hierarchy +========================= + +Service org.bluez.obex +Interface org.bluez.obex.MessageAccess +Object path [variable prefix]/{session0,session1,...} + +Methods void SetFolder(string name) + + Set working directory for current session, *name* may + be the directory name or '..[/dir]'. + + array{dict} ListFolders(dict filter) + + Returns a dictionary containing information about + the current folder content. + + The following keys are defined: + + string Name : Folder name + + Possible filters: Offset and MaxCount + + array{string} ListFilterFields() + + Return all available fields that can be used in Fields + filter. + + array{object, dict} ListMessages(string folder, dict filter) + + Returns an array containing the messages found in the + given folder. + + Possible Filters: Offset, MaxCount, Fields, Type, + PeriodStart, PeriodEnd, Status, Recipient, Sender, + Priority + + Each message is represented by an object path followed + by a dictionary of the properties. + + Properties: + + string Subject: + + Message subject + + string Timestamp: + + Message timestamp + + string Sender: + + Message sender name + + string SenderAddress: + + Message sender address + + string ReplyTo: + + Message Reply-To address + + string Recipient: + + Message recipient name + + string RecipientAddress: + + Message recipient address + + string Type: + + Message type + + Possible values: "EMAIL", "SMS_GSM", + "SMS_CDMA" and "MMS" + + uint64 Size: + + Message size in bytes + + string Status: + + Message reception status + + Possible values: "complete", + "fractioned" and "notification" + + boolean Priority: + + Message priority flag + + boolean Read: + + Message read flag + + boolean Sent: + + Message sent flag + + boolean Protected: + + Message protected flag + + void UpdateInbox(void) + + Request remote to update its inbox. + + +Filter: uint16 Offset: + + Offset of the first item, default is 0 + + uint16 MaxCount: + + Maximum number of items, default is 1024 + + array{string} Fields: + + Message fields, default is all values. + + Possible values can be query with ListFilterFields. + + array{string} Types: + + Filter messages by type. + + Possible values: "sms", "email", "mms". + + string PeriodBegin: + + Filter messages by starting period. + + Possible values: Date in "YYYYMMDDTHHMMSS" format. + + string PeriodEnd: + + Filter messages by ending period. + + Possible values: Date in "YYYYMMDDTHHMMSS" format. + + boolean Read: + + Filter messages by read flag. + + Possible values: True for read or False for unread + + string Recipient: + + Filter messages by recipient address. + + string Sender: + + Filter messages by sender address. + + gboolean Priority: + + Filter messages by priority flag. + + Possible values: True for high priority or False for + non-high priority + +Message hierarchy +================= + +Service org.bluez.obex +Interface org.bluez.obex.Message +Object path [variable prefix]/{session0,session1,...}/{message0,...} + +Methods object, dict Get(string targetfile, boolean attachment) + + Download message and store it in the target file. + + If an empty target file is given, a temporary file + will be automatically generated. + + 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. + +Properties string Subject [readonly] + + Message subject + + string Timestamp [readonly] + + Message timestamp + + string Sender [readonly] + + Message sender name + + string SenderAddress [readonly] + + Message sender address + + string ReplyTo [readonly] + + Message Reply-To address + + string Recipient [readonly] + + Message recipient name + + string RecipientAddress [readonly] + + Message recipient address + + string Type [readonly] + + Message type + + Possible values: "EMAIL", "SMS_GSM", + "SMS_CDMA" and "MMS" + + uint64 Size [readonly] + + Message size in bytes + + string Status [readonly] + + Message reception status + + Possible values: "complete", + "fractioned" and "notification" + + boolean Priority [readonly] + + Message priority flag + + boolean Read [read/write] + + Message read flag + + boolean Deleted [writeonly] + + Message read flag + + boolean Sent [readonly] + + Message sent flag + + boolean Protected [readonly] + + Message protected flag diff --git a/obexd/client/map.c b/obexd/client/map.c index 9cae20e10..8cdebb392 100644 --- a/obexd/client/map.c +++ b/obexd/client/map.c @@ -44,8 +44,8 @@ "\xBB\x58\x2B\x40\x42\x0C\x11\xDB\xB0\xDE\x08\x00\x20\x0C\x9A\x66" #define OBEX_MAS_UUID_LEN 16 -#define MAP_INTERFACE "org.bluez.obex.MessageAccess" -#define MAP_MSG_INTERFACE "org.bluez.obex.Message" +#define MAP_INTERFACE "org.bluez.obex.MessageAccess1" +#define MAP_MSG_INTERFACE "org.bluez.obex.Message1" #define ERROR_INTERFACE "org.bluez.obex.Error" #define MAS_UUID "00001132-0000-1000-8000-00805f9b34fb" -- 2.47.3