aboutsummaryrefslogtreecommitdiff
path: root/introspection/org.freedesktop.ModemManager.Modem.Gsm.SMS.xml
blob: 15953b88b959919fdc9b567aff5f09ead9111ec2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<?xml version="1.0" encoding="UTF-8" ?>

<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <interface name="org.freedesktop.ModemManager.Modem.Gsm.SMS">
    <method name="Delete">
      <tp:docstring>
	Delete an SMS message.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_delete"/>
      <arg name="index" type="u" direction="in">
	<tp:docstring>
	  The index of the SMS.
	</tp:docstring>
      </arg>
    </method>

    <method name="Get">
      <tp:docstring>
	Retrieve an SMS from the SIM card.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_get"/>
      <arg name="index" type="u" direction="in">
	<tp:docstring>
	  The index of the SMS.
	</tp:docstring>
      </arg>
      <arg name="sms" type="a{sv}" direction="out">
        <tp:docstring>
          A dictionary containing SMS properties of the SMS specified by the given index.  This dictionary may contain the following key/value pairs:

          number   : string - Phone number (mandatory)
          text     : string - SMS text (mandatory)
          smsc     : string - SMS service center number (optional)
          validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional)
          class    : uint (0..3) - Message importance and location (optional)
          completed: boolean - Whether all message parts have been received or not (optional)
          index    : uint - Index of message (for Get and Delete) (optional)
        </tp:docstring>
      </arg>
    </method>

    <method name="GetFormat">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_get_format"/>
      <arg name="result" type="u" direction="out"/>
    </method>

    <method name="SetFormat">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_set_format"/>
      <arg name="format" type="u" direction="in"/>
    </method>

    <method name="GetSmsc">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_get_smsc"/>
      <arg name="result" type="s" direction="out"/>
    </method>

    <method name="SetSmsc">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_set_smsc"/>
      <arg name="smsc" type="s" direction="in"/>
    </method>

    <method name="List">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_list"/>
      <arg name="result" type="aa{sv}" direction="out"/>
    </method>

    <method name="Save">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_save"/>
      <arg name="properties" type="a{sv}" direction="in">
	<tp:docstring>
	  SMS properties to save with the following key values:

	  number   : string - Phone number (mandatory)
	  text     : string - SMS text (mandatory)
	  smsc     : string - SMS service center number (optional)
	  validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional)
	  class    : uint (0..3) - Message importance and location (optional)
	</tp:docstring>
      </arg>
      <arg name="index" type="au" direction="out"/>
    </method>

    <method name="Send">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_send"/>
      <arg name="properties" type="a{sv}" direction="in">
	<tp:docstring>
	  SMS properties to save with the following key values:

	  number   : string - Phone number (mandatory)
	  text     : string - SMS text (mandatory)
	  smsc     : string - SMS service center number (optional)
	  validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional)
	  class    : uint (0..3) - Message importance and location (optional)
	</tp:docstring>
      </arg>
      <arg name="result" type="au" direction="out"/>
    </method>

    <method name="SendFromStorage">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_send_from_storage"/>
      <arg name="index" type="u" direction="in"/>
    </method>

    <method name="SetIndication">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_gsm_modem_sms_set_indication"/>
      <arg name="mode" type="u" direction="in"/>
      <arg name="mt" type="u" direction="in"/>
      <arg name="bm" type="u" direction="in"/>
      <arg name="ds" type="u" direction="in"/>
      <arg name="bfr" type="u" direction="in"/>
    </method>

    <signal name="SmsReceived">
      <tp:docstring>
        Emitted when any part of a new SMS has been received (but not for subsequent parts, if any).  Not all parts may have been received and the message may not be complete; if it is, the 'complete' argument will be TRUE.
      </tp:docstring>
      <arg name="index" type="u">
        <tp:docstring>
          Index of the new SMS.
        </tp:docstring>
      </arg>
      <arg name="complete" type="b">
        <tp:docstring>
          TRUE if all message parts have been received, otherwise FALSE.
        </tp:docstring>
      </arg>
    </signal>

    <signal name="Completed">
      <tp:docstring>
        Emitted when the complete-ness status of an SMS message changes.  An SMS may not necessarily be complete when the first part is received; this signal will be emitted when all parts have been received, even for single-part messages.
      </tp:docstring>
      <arg name="index" type="u">
        <tp:docstring>
          The index of the SMS.
        </tp:docstring>
      </arg>
      <arg name="completed" type="b">
        <tp:docstring>
          TRUE if all message parts have been received, otherwise FALSE.
        </tp:docstring>
      </arg>
    </signal>

  </interface>
</node>