org.freesmartphone.GSM/org.freesmartphone.GSM.SMS.xml.in

   1 <?xml version="1.0"?>
   2 <node name="/" xmlns:fso="http://www.freesmartphone.org/schemas/DBusSpecExtension" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd" doc:id="freesmartphone-gsm-sms-interface">
   3
   4 <doc:doc>
   5   <doc:summary>freesmartphone.org GSM SMS Interface</doc:summary>
   6   <doc:version>1.0.0</doc:version>
   7 </doc:doc>
   8
   9 <interface name="org.freesmartphone.GSM.SMS">
  10
  11   <doc:doc>
  12     <doc:para>
  13       org.freesmartphone.GSM.SMS is a high level interface for
  14       textual Short Message Service (SMS). If you have special
  15       requirements or need direct access to individual messages,
  16       you may use the corresponding SMS functions provided by
  17       org.freesmartphone.GSM.SIM.
  18     </doc:para>
  19   </doc:doc>
  20
  21 <!-- Not clear whether we want to have this
  22   <method name="GetServiceBearer">
  23     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  24     <arg type="s" name="mode" direction="out" />
  25     <fso:throws type="org.freesmartphone.GSM" />
  26     <fso:throws type="org.freesmartphone" />
  27   </method>
  28
  29   <method name="SetServiceBearer">
  30     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  31     <arg type="s" name="mode" direction="in" />
  32     <fso:throws type="org.freesmartphone.GSM" />
  33     <fso:throws type="org.freesmartphone" />
  34   </method>
  35   -->
  36
  37   <method name="RetrieveTextMessages">
  38     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  39     <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="QFsoSIMMessageList" />
  40     <doc:doc>
  41       <doc:description>Retrieve all text messages.</doc:description>
  42     </doc:doc>
  43     <arg type="a(issssa{sv})" name="messages" direction="out" fso:type="org.freesmartphone.GSM.SIMMessage">
  44       <doc:doc>
  45         <doc:summary>
  46           Messages matching the given category. This is an array of four-tuples. Every entry has the following structure:
  47           [ul]
  48             [li](int:index) = storage index,[/li]
  49             [li](string:status) = status of message, one of ("read", "unread", "sent", "unsent"),[/li]
  50             [li](string:number) = sender number.[/li]
  51             [li](string:timestamp) = timestamp.[/li]
  52             [li](string:content) = contents of the message.[/li]
  53           [/ul]
  54         </doc:summary>
  55       </doc:doc>
  56     </arg>
  57     <fso:throws type="org.freesmartphone.GSM" />
  58     <fso:throws type="org.freesmartphone" />
  59   </method>
  60
  61   <method name="GetSizeForTextMessage">
  62     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  63     <doc:doc>
  64       <doc:description>Calculates the number of GSM Short Messages necessary to deliver a given text.</doc:description>
  65     </doc:doc>
  66     <arg type="s" name="contents" direction="in">
  67       <doc:doc>
  68         <doc:summary>The contents of the message.</doc:summary>
  69       </doc:doc>
  70     </arg>
  71     <arg type="u" name="messages" direction="out">
  72       <doc:doc>
  73         <doc:summary>
  74           The number of SMS to be sent, if this message were to be delivered.
  75         </doc:summary>
  76       </doc:doc>
  77     </arg>
  78     <fso:throws type="org.freesmartphone.GSM" />
  79     <fso:throws type="org.freesmartphone" />
  80   </method>
  81
  82   <method name="SendTextMessage">
  83     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  84     <doc:doc>
  85       <doc:description>Sends a text message via the GSM Short Message Service (SMS)</doc:description>
  86       <doc:inote>
  87         Text messages can be of unlimited length. They might get fragmented by the
  88         underlying message transport layers though. This will happen transparently.
  89       </doc:inote>
  90     </doc:doc>
  91     <arg type="s" name="recipient_number" direction="in">
  92       <doc:doc>
  93         <doc:summary>The number of the recipient.</doc:summary>
  94       </doc:doc>
  95     </arg>
  96     <arg type="s" name="contents" direction="in">
  97       <doc:doc>
  98         <doc:summary>The contents of the message.</doc:summary>
  99       </doc:doc>
 100     </arg>
 101     <arg type="b" name="report" direction="in">
 102       <doc:doc>
 103         <doc:summary>
 104           If true, status reports (message receipts) will be sent by the
 105           SMS Center, delivered via the org.freesmartphone.GSM.SMS.IncomingMessageReceipt signal.
 106         </doc:summary>
 107       </doc:doc>
 108     </arg>
 109     <arg type="i" name="reference" direction="out">
 110       <doc:doc>
 111         <doc:summary>
 112           This is the message-reference number of this message.
 113           This can be used to identify status reports.
 114         </doc:summary>
 115       </doc:doc>
 116     </arg>
 117     <arg type="s" name="timestamp" direction="out">
 118       <doc:doc>
 119         <doc:summary>
 120         The timestamp this message was received by the SMSC.
 121         </doc:summary>
 122       </doc:doc>
 123     </arg>
 124     <fso:throws type="org.freesmartphone.GSM" />
 125     <fso:throws type="org.freesmartphone" />
 126   </method>
 127
 128   <signal name="IncomingTextMessage">
 129     <doc:doc>
 130       <doc:description>
 131         Sent, when a text message has been received.
 132       </doc:description>
 133       <doc:inote>
 134       </doc:inote>
 135     </doc:doc>
 136     <arg type="s" name="number">
 137       <doc:doc>
 138         <doc:summary>The number of the sender.</doc:summary>
 139       </doc:doc>
 140     </arg>
 141     <arg type="s" name="timestamp">
 142       <doc:doc>
 143         <doc:summary>The timestamp of the message.</doc:summary>
 144       </doc:doc>
 145     </arg>
 146     <arg type="s" name="contents">
 147       <doc:doc>
 148         <doc:summary>The contents of the message.</doc:summary>
 149       </doc:doc>
 150     </arg>
 151   </signal>
 152
 153   <signal name="IncomingMessageReport">
 154     <doc:doc>
 155       <doc:description>
 156         Sent when a status report for a message has been received.
 157       </doc:description>
 158       <doc:inote>
 159         The signature of this signal is preliminary and is bound to change.
 160       </doc:inote>
 161     </doc:doc>
 162     <arg type="i" name="reference">
 163       <doc:doc>
 164         <doc:summary>
 165           The message-reference number as returned by org.freesmartphone.GSM.SMS.SendTextMessage
 166         </doc:summary>
 167       </doc:doc>
 168     </arg>
 169     <arg type="s" name="status">
 170       <doc:doc>
 171         <doc:summary>
 172         The status. Expected values are:
 173         [ul]
 174             [li]COMPLETED_RECEIVED[/li]
 175             [li]COMPLETED_UNABLE_TO_CONFIRM[/li]
 176             [li]COMPLETED_REPLACED[/li]
 177             [li]COMPLETED_LAST[/li]
 178             [li]TEMPORARY_CONGESTION[/li]
 179             [li]TEMPORARY_SME_BUSY[/li]
 180             [li]TEMPORARY_NO_RESPONSE[/li]
 181             [li]TEMPORARY_SERVICE_REJECTED[/li]
 182             [li]TEMPORARY_QOS_UNAVAILABLE[/li]
 183             [li]TEMPORARY_SME_ERROR[/li]
 184             [li]TEMPORARY_LAST[/li]
 185             [li]PERMANENT_RP_ERROR[/li]
 186             [li]PERMANENT_INVALID_DESTINATION[/li]
 187             [li]PERMANENT_CONNECTION_REJECTED[/li]
 188             [li]PERMANENT_NOT_OBTAINABLE[/li]
 189             [li]PERMANENT_QOS_UNAVAILABLE[/li]
 190             [li]PERMANENT_INTERWORKING_UNAVAILABLE[/li]
 191             [li]PERMANENT_VALIDITY_PERIOD_EXPIRED[/li]
 192             [li]PERMANENT_DELETED[/li]
 193             [li]PERMANENT_SC_ADMIN_DELETED[/li]
 194             [li]PERMANENT_SM_DOES_NOT_EXIST[/li]
 195             [li]PERMANENT_LAST[/li]
 196             [li]TEMPFINAL_CONGESTION[/li]
 197             [li]TEMPFINAL_SME_BUSY[/li]
 198             [li]TEMPFINAL_NO_RESPONSE[/li]
 199             [li]TEMPFINAL_SERVICE_REJECTED[/li]
 200             [li]TEMPFINAL_QOS_UNAVAILABLE[/li]
 201             [li]TEMPFINAL_SME_ERROR[/li]
 202             [li]TEMPFINAL_LAST
 203         [/ul]
 204         </doc:summary>
 205       </doc:doc>
 206     </arg>
 207     <arg type="s" name="sender_number">
 208       <doc:doc>
 209         <doc:summary>The number of the sender.</doc:summary>
 210       </doc:doc>
 211     </arg>
 212     <arg type="s" name="contents">
 213       <doc:doc>
 214         <doc:summary>Optional contents of the receipt. Will usually be empty.</doc:summary>
 215       </doc:doc>
 216     </arg>
 217   </signal>
 218
 219 </interface>
 220 </node>