2
<node name="/Connection_Interface_Cellular"
3
xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
5
<tp:copyright>Copyright © 2008-2010 Nokia Corporation</tp:copyright>
6
<tp:copyright>Copyright © 2010 Collabora Ltd.</tp:copyright>
7
<tp:license xmlns="http://www.w3.org/1999/xhtml">
8
<p>This library is free software; you can redistribute it and/or
9
modify it under the terms of the GNU Lesser General Public
10
License as published by the Free Software Foundation; either
11
version 2.1 of the License, or (at your option) any later version.</p>
13
<p>This library is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16
Lesser General Public License for more details.</p>
18
<p>You should have received a copy of the GNU Lesser General Public
19
License along with this library; if not, write to the Free Software
20
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24
<interface name="org.freedesktop.Telepathy.Connection.Interface.Cellular">
25
<tp:added version="0.19.8">(as stable API)</tp:added>
27
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
28
<p>This interface is for various cellular things (GSM and/or CDMA) that
29
aren't really applicable to other protocols.</p>
32
<property name="MessageValidityPeriod" tp:name-for-bindings="Message_Validity_Period"
33
type="u" access="readwrite">
34
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
35
<p>Define how long should the service centre try message delivery before
36
giving up, failing delivery and deleting the message. A value of 0
37
means to use the service centre's default period.</p>
39
<p>The value specified is in seconds. Note that various protocols or
40
implementations may round the value up (eg. to a minute or hour
41
precision). The maximum validity period may vary depending on
42
protocol or provider.</p>
44
<p>Connections with this interface SHOULD provide this property as a
45
parameter of the same (fully-qualified) name to <tp:dbus-ref
46
namespace="org.freedesktop.Telepathy"
47
>ConnectionManager.RequestConnection</tp:dbus-ref>, with the
48
<code>DBus_Property</code> flag. For connections managed by the
50
namespace="org.freedesktop.Telepathy">AccountManager</tp:dbus-ref>,
51
this property SHOULD be set via the Account Manager as follows:</p>
54
<code><tp:dbus-ref namespace="org.freedesktop.Telepathy.Account"
55
>UpdateParameters</tp:dbus-ref>({
56
"org.freedesktop.Telepathy.Connection.Interface.Cellular.MessageValidityPeriod": <var>new_validity_period</var>
60
<p>The AccountManager provides change-notification, as long as all
61
other clients cooperate by using it instead of setting this property
66
<property name="MessageServiceCentre" tp:name-for-bindings="Message_Service_Centre"
67
type="s" access="readwrite">
68
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
69
<p>Address for the messaging service centre. Typically (as is the case
70
for GSM's SMSC), it's the ISDN / telephony address (ie. a phone
73
<p>Connections with this interface SHOULD provide this property as a
74
parameter of the same (fully-qualified) name to <tp:dbus-ref
75
namespace="org.freedesktop.Telepathy"
76
>ConnectionManager.RequestConnection</tp:dbus-ref>, with the
77
<code>DBus_Property</code> flag. For connections managed by the
79
namespace="org.freedesktop.Telepathy">AccountManager</tp:dbus-ref>,
80
this property SHOULD be set via the Account Manager as follows:</p>
83
<code><tp:dbus-ref namespace="org.freedesktop.Telepathy.Account"
84
>UpdateParameters</tp:dbus-ref>({
85
"org.freedesktop.Telepathy.Connection.Interface.Cellular.MessageServiceCentre": <var>new_smsc_address</var>
89
<p>The AccountManager provides change-notification, as long as all
90
other clients cooperate by using it instead of setting this property
95
<property name="IMSI" tp:name-for-bindings="IMSI" type="s" access="read">
96
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
97
<p>The International Mobile Subscriber Identifier, if it exists. This
98
would originate from a SIM card. If the IMSI is unknown, this will
99
contain an empty string ("").</p>
103
<signal name="IMSIChanged" tp:name-for-bindings="IMSI_Changed">
105
Emitted when the IMSI for the connection changes. This sort of thing
106
is rare, but could happen on cellular phones that allow hot-swapping
107
of SIM cards. In the case of SIM swapping, this signal would be
108
emitted twice; the first time while the SIM is being ejected (with an
109
empty string), and the second time after a new SIM has been inserted
110
(assuming that the IMSI can be determined from the new SIM).
113
<arg name="IMSI" type="s">
115
The new IMSI value. This may be an empty string in the case where
116
the IMSI is being reset or removed.
121
<property name="MessageReducedCharacterSet"
122
tp:name-for-bindings="Message_Reduced_Character_Set"
123
type="b" access="readwrite">
124
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
125
<p>Determines whether SMSes containing characters that do not fit into
126
a 7‐bit GSM character set should be sent as UCS‐2, or lossily
127
recoded. If <code>False</code> (which SHOULD be the default),
128
messages will be sent with no loss of fidelity (at the potential
129
financial cost of using twice as many SMSes); if <code>True</code>,
130
the message will be recoded in an implementation‐specific way to fit
131
into a country‐specific GSM reduced character set.</p>
133
<p>Connections with this interface SHOULD provide this property as a
134
parameter of the same (fully-qualified) name to <tp:dbus-ref
135
namespace="org.freedesktop.Telepathy"
136
>ConnectionManager.RequestConnection</tp:dbus-ref>, with the
137
<code>DBus_Property</code> flag. For connections managed by the
139
namespace="org.freedesktop.Telepathy">AccountManager</tp:dbus-ref>,
140
this property SHOULD be set via the Account Manager as follows:</p>
143
<code><tp:dbus-ref namespace="org.freedesktop.Telepathy.Account"
144
>UpdateParameters</tp:dbus-ref>({
145
"org.freedesktop.Telepathy.Connection.Interface.Cellular.MessageReducedCharacterSet": <var>new_value</var>
149
<p>The AccountManager provides change-notification, as long as all
150
other clients cooperate by using it instead of setting this property
156
<!-- vim:set sw=2 sts=2 et ft=xml: -->
added
removed
spec/Connection_Interface_Cellular.xml
