dbus/introspection/org.freedesktop.ModemManager1.Modem.Messaging.xml

0001 <?xml version="1.0" encoding="UTF-8" ?>
0002
0003 <!--
0004  ModemManager 1.0 Interface Specification
0005
0006    Copyright (C) 2008 Novell, Inc.
0007    Copyright (C) 2008-2013 Red Hat, Inc.
0008    Copyright (C) 2011-2013 Google, Inc.
0009    Copyright (C) 2011-2013 Lanedo GmbH
0010 -->
0011
0012 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0013
0014   <!--
0015       org.freedesktop.ModemManager1.Modem.Messaging:
0016       @short_description: The ModemManager Messaging interface.
0017
0018       The Messaging interface handles sending SMS messages and notification of new
0019       incoming messages.
0020   -->
0021   <interface name="org.freedesktop.ModemManager1.Modem.Messaging">
0022
0023     <!--
0024         List:
0025         @result: The list of SMS object paths.
0026
0027         Retrieve all SMS messages.
0028
0029         This method should only be used once and subsequent information
0030         retrieved either by listening for the
0031         #org.freedesktop.ModemManager1.Modem.Messaging::Added signal,
0032         or by querying the specific SMS object of interest.
0033     -->
0034     <method name="List">
0035       <arg name="result" type="ao" direction="out" />
0036     </method>
0037
0038     <!--
0039         Delete:
0040         @path: The object path of the SMS to delete.
0041
0042         Delete an SMS message.
0043     -->
0044     <method name="Delete">
0045       <arg name="path" type="o" direction="in" />
0046     </method>
0047
0048     <!--
0049         Create:
0050         @properties: Message properties from the <link linkend="gdbus-org.freedesktop.ModemManager1.Sms">SMS D-Bus interface</link>.
0051         @path: The object path of the new message object.
0052
0053         Creates a new message object.
0054
0055         The '<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Number">Number</link>'
0056         and
0057         either '<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Text">Text</link>' or
0058         '<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Data">Data</link>'
0059         properties are mandatory, others are optional.
0060
0061         If the SMSC is not specified and one is required, the default SMSC is
0062         used.
0063     -->
0064     <method name="Create">
0065       <arg name="properties" type="a{sv}" direction="in">
0066         <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
0067       </arg>
0068       <arg name="path"       type="o"     direction="out" />
0069     </method>
0070
0071     <!--
0072         Added:
0073         @path: Object path of the new SMS.
0074         @received: %TRUE if the message was received from the network, as opposed to being added locally.
0075
0076         Emitted when any part of a new SMS has been received or added (but not
0077         for subsequent parts, if any). For messages received from the network,
0078         not all parts may have been received and the message may not be
0079         complete.
0080
0081         Check the
0082         '<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.State">State</link>'
0083         property to determine if the message is complete.
0084     -->
0085     <signal name="Added">
0086       <arg name="path" type="o" />
0087       <arg name="received" type="b" />
0088     </signal>
0089
0090     <!--
0091         Deleted:
0092         @path: Object path of the now deleted SMS.
0093
0094         Emitted when a message has been deleted.
0095     -->
0096     <signal name="Deleted">
0097       <arg name="path" type="o" />
0098     </signal>
0099
0100     <!--
0101         Messages:
0102
0103         The list of SMS object paths.
0104     -->
0105     <property name="Messages" type="ao" access="read" />
0106
0107     <!--
0108         SupportedStorages:
0109
0110         A list of <link linkend="MMSmsStorage">MMSmsStorage</link> values,
0111         specifying the storages supported by this modem for storing and
0112         receiving SMS.
0113     -->
0114     <property name="SupportedStorages" type="au" access="read">
0115     <annotation name="org.qtproject.QtDBus.QtTypeName" value="UIntList"/>
0116     </property>
0117
0118     <!--
0119         DefaultStorage:
0120
0121         A <link linkend="MMSmsStorage">MMSmsStorage</link> value,
0122         specifying the storage to be used when receiving or storing SMS.
0123     -->
0124     <property name="DefaultStorage" type="u" access="read" />
0125
0126   </interface>
0127 </node>