Re: [PATCH 1/3] doc: Add message state API

2011-01-13 Thread Denis Kenzior
Hi Faiyaz,

On 01/06/2011 01:50 PM, Faiyaz Baxamusa wrote:
> ---
>  Makefile.am   |2 +-
>  doc/cdma-message-api.txt  |5 +
>  doc/message-api.txt   |   24 +---

Please rename this file into doc/messagemanager-api.txt

>  doc/message-state-api.txt |   27 +++

And this one can be message-api.txt

>  4 files changed, 34 insertions(+), 24 deletions(-)
>  create mode 100644 doc/message-state-api.txt
> 
> diff --git a/Makefile.am b/Makefile.am
> index 09dc9ad..14f53ef 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -369,7 +369,7 @@ doc_files = doc/overview.txt doc/ofono-paper.txt 
> doc/release-faq.txt \
>   doc/phonebook-api.txt doc/radio-settings-api.txt \
>   doc/sim-api.txt doc/stk-api.txt \
>   doc/audio-settings-api.txt doc/text-telephony-api.txt \
> - doc/calypso-modem.txt
> + doc/calypso-modem.txt doc/message-state-api.txt
>  
>  
>  test_scripts = test/backtrace \
> diff --git a/doc/cdma-message-api.txt b/doc/cdma-message-api.txt
> index 8e6b9ea..c3d03f8 100644
> --- a/doc/cdma-message-api.txt
> +++ b/doc/cdma-message-api.txt
> @@ -110,3 +110,8 @@ Propertiesboolean UseDeliveryAcknowledgement
>   The call back number for the user.  If the number is
>   empty, then the optional field is not included
>   in the encoded PDU.
> +
> +Message hierarchy
> +===
> +
> +Please refer to message-state-api.txt

Please get rid of this chunk.

> diff --git a/doc/message-api.txt b/doc/message-api.txt
> index f7ab22a..e6c8522 100644
> --- a/doc/message-api.txt
> +++ b/doc/message-api.txt
> @@ -90,26 +90,4 @@ Properties string ServiceCenterAddress
>  Message hierarchy
>  ===
>  
> -Service  org.ofono
> -Interfaceorg.ofono.Message
> -Object path  [variable prefix]/{modem0,modem1,...}/{message_01,...}
> -
> -Methods  dict GetProperties()
> -
> - Returns properties for the message object. See
> - the properties section for available properties.
> -
> - Possible Errors: [service].Error.InvalidArguments
> -
> -Signals  PropertyChanged(string name, variant value)
> -
> - This signal indicates a changed value of the given
> - property.
> -
> -Properties   string State
> -
> - Contains the state of the message object.  Possible
> - values are:
> - "pending",
> - "sent",
> - "failed"
> +Please refer to message-state-api.txt
> diff --git a/doc/message-state-api.txt b/doc/message-state-api.txt
> new file mode 100644
> index 000..edd0cbf
> --- /dev/null
> +++ b/doc/message-state-api.txt
> @@ -0,0 +1,27 @@
> +Message hierarchy
> +===
> +
> +Service  org.ofono
> +Interfaceorg.ofono.Message
> +Object path  [variable prefix]/{modem0,modem1,...}/{message_01,...}
> +
> +Methods  dict GetProperties()
> +
> + Returns properties for the message object. See
> + the properties section for available properties.
> +
> + Possible Errors: [service].Error.InvalidArguments
> +
> +Signals  PropertyChanged(string name, variant value)
> +
> + This signal indicates a changed value of the given
> + property.
> +
> +Properties   string State
> +
> + Contains the state of the message object.  Possible
> + values are:
> + "pending",
> + "sent",
> + "failed"
> + "invalid"

Please get rid of this invalid state.

Regards,
-Denis

___
ofono mailing list
ofono@ofono.org
http://lists.ofono.org/listinfo/ofono


Re: [PATCH 1/3] doc: Add message state API

2011-01-13 Thread Faiyaz Baxamusa

Hi Denis,

On 01/13/2011 10:04 AM, ext Denis Kenzior wrote:

Hi Faiyaz,

On 01/06/2011 01:50 PM, Faiyaz Baxamusa wrote:

---
  Makefile.am   |2 +-
  doc/cdma-message-api.txt  |5 +
  doc/message-api.txt   |   24 +---


Please rename this file into doc/messagemanager-api.txt


I will rename current doc/message-api.txt to
doc/messagemanager-api.txt file and also rename doc/cdma-message-api.txt 
to doc/cdma-messagemanager-api.txt





  doc/message-state-api.txt |   27 +++


And this one can be message-api.txt


I will rename the new file to doc/message-api.txt




  4 files changed, 34 insertions(+), 24 deletions(-)
  create mode 100644 doc/message-state-api.txt

diff --git a/Makefile.am b/Makefile.am
index 09dc9ad..14f53ef 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -369,7 +369,7 @@ doc_files = doc/overview.txt doc/ofono-paper.txt 
doc/release-faq.txt \
doc/phonebook-api.txt doc/radio-settings-api.txt \
doc/sim-api.txt doc/stk-api.txt \
doc/audio-settings-api.txt doc/text-telephony-api.txt \
-   doc/calypso-modem.txt
+   doc/calypso-modem.txt doc/message-state-api.txt


  test_scripts = test/backtrace \
diff --git a/doc/cdma-message-api.txt b/doc/cdma-message-api.txt
index 8e6b9ea..c3d03f8 100644
--- a/doc/cdma-message-api.txt
+++ b/doc/cdma-message-api.txt
@@ -110,3 +110,8 @@ Properties  boolean UseDeliveryAcknowledgement
The call back number for the user.  If the number is
empty, then the optional field is not included
in the encoded PDU.
+
+Message hierarchy
+===
+
+Please refer to message-state-api.txt


Please get rid of this chunk.



Sure.


diff --git a/doc/message-api.txt b/doc/message-api.txt
index f7ab22a..e6c8522 100644
--- a/doc/message-api.txt
+++ b/doc/message-api.txt
@@ -90,26 +90,4 @@ Properties   string ServiceCenterAddress
  Message hierarchy
  ===

-Serviceorg.ofono
-Interface  org.ofono.Message
-Object path[variable prefix]/{modem0,modem1,...}/{message_01,...}
-
-Methodsdict GetProperties()
-
-   Returns properties for the message object. See
-   the properties section for available properties.
-
-   Possible Errors: [service].Error.InvalidArguments
-
-SignalsPropertyChanged(string name, variant value)
-
-   This signal indicates a changed value of the given
-   property.
-
-Properties string State
-
-   Contains the state of the message object.  Possible
-   values are:
-   "pending",
-   "sent",
-   "failed"
+Please refer to message-state-api.txt
diff --git a/doc/message-state-api.txt b/doc/message-state-api.txt
new file mode 100644
index 000..edd0cbf
--- /dev/null
+++ b/doc/message-state-api.txt
@@ -0,0 +1,27 @@
+Message hierarchy
+===
+
+Serviceorg.ofono
+Interface  org.ofono.Message
+Object path[variable prefix]/{modem0,modem1,...}/{message_01,...}
+
+Methodsdict GetProperties()
+
+   Returns properties for the message object. See
+   the properties section for available properties.
+
+   Possible Errors: [service].Error.InvalidArguments
+
+SignalsPropertyChanged(string name, variant value)
+
+   This signal indicates a changed value of the given
+   property.
+
+Properties string State
+
+   Contains the state of the message object.  Possible
+   values are:
+   "pending",
+   "sent",
+   "failed"
+   "invalid"


Please get rid of this invalid state.



Sure, will remove "invalid"


Regards,
-Denis



___
ofono mailing list
ofono@ofono.org
http://lists.ofono.org/listinfo/ofono