dbus/introspection/org.freedesktop.ModemManager1.Sim.xml

0001 <?xml version="1.0" encoding="UTF-8" ?>
0002
0003 <!--
0004  ModemManager 1.0 Interface Specification
0005
0006    Copyright (C) 2011-2013 Red Hat, Inc.
0007    Copyright (C) 2011-2013 Google, Inc.
0008    Copyright (C) 2011-2013 Lanedo GmbH
0009 -->
0010
0011 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0012
0013   <!--
0014       org.freedesktop.ModemManager1.Sim:
0015       @short_description: The ModemManager SIM interface.
0016
0017       The SIM interface handles communication with SIM, USIM, and RUIM (CDMA
0018       SIM) cards.
0019   -->
0020   <interface name="org.freedesktop.ModemManager1.Sim">
0021
0022     <!--
0023         SendPin:
0024         @pin: A string containing the PIN code.
0025
0026         Send the PIN to unlock the SIM card.
0027
0028         Since: 1.0
0029     -->
0030     <method name="SendPin">
0031       <arg name="pin" type="s" direction="in" />
0032     </method>
0033
0034     <!--
0035         SendPuk:
0036         @puk: A string containing the PUK code.
0037         @pin: A string containing the PIN code.
0038
0039         Send the PUK and a new PIN to unlock the SIM card.
0040
0041         Since: 1.0
0042     -->
0043     <method name="SendPuk">
0044       <arg name="puk" type="s" direction="in" />
0045       <arg name="pin" type="s" direction="in" />
0046     </method>
0047
0048     <!--
0049         EnablePin:
0050         @pin: A string containing the PIN code.
0051         @enabled: %TRUE to enable PIN checking, %FALSE otherwise.
0052
0053         Enable or disable the PIN checking.
0054
0055         Since: 1.0
0056     -->
0057     <method name="EnablePin">
0058       <arg name="pin"     type="s" direction="in" />
0059       <arg name="enabled" type="b" direction="in" />
0060     </method>
0061
0062     <!--
0063         ChangePin:
0064         @old_pin: A string containing the current PIN code.
0065         @new_pin: A string containing the new PIN code.
0066
0067         Change the PIN code.
0068
0069         Since: 1.0
0070     -->
0071     <method name="ChangePin">
0072       <arg name="old_pin" type="s" direction="in" />
0073       <arg name="new_pin" type="s" direction="in" />
0074     </method>
0075
0076     <!--
0077         SetPreferredNetworks:
0078         @preferred_plmns: List of preferred networks.
0079
0080         Stores the provided preferred network list to the SIM card. Each entry contains
0081         an operator id string (<literal>"MCCMNC"</literal>) consisting of 5 or 6 digits,
0082         and an <link linkend="MMModemAccessTechnology">MMModemAccessTechnology</link> mask
0083         to store to SIM card if supported.
0084
0085         This method removes any pre-existing entries of the preferred network list. Note
0086         that even if this operation fails, the preferred network list on the SIM card may
0087         have changed. Read the <link linkend="gdbus-property-org-freedesktop-ModemManager1-Sim.PreferredNetworks">
0088         PreferredNetworks</link> property to get the up-to-date list.
0089
0090         Since: 1.18
0091     -->
0092     <method name="SetPreferredNetworks">
0093       <arg name="preferred_networks" type="a(su)" direction="in" />
0094       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
0095     </method>
0096
0097     <!--
0098         Active:
0099
0100         Boolean indicating whether the SIM is currently active.
0101
0102         On systems that support Multi SIM Single Standby, only one SIM may be
0103         active at any given time, which will be the one considered primary.
0104
0105         On systems that support Multi SIM Multi Standby, more than one SIM may
0106         be active at any given time, but only one of them is considered primary.
0107
0108         Since: 1.16
0109     -->
0110     <property name="Active" type="b" access="read" />
0111
0112     <!--
0113         SimIdentifier:
0114
0115         The ICCID of the SIM card.
0116
0117         This may be available before the PIN has been entered depending
0118         on the device itself.
0119
0120         Since: 1.0
0121     -->
0122     <property name="SimIdentifier" type="s" access="read" />
0123
0124     <!--
0125         Imsi:
0126
0127         The IMSI of the SIM card, if any.
0128
0129         Since: 1.0
0130     -->
0131     <property name="Imsi" type="s" access="read" />
0132
0133     <!--
0134         Eid:
0135
0136         The EID of the SIM card, if any.
0137
0138         Since: 1.16
0139     -->
0140     <property name="Eid" type="s" access="read" />
0141
0142     <!--
0143         OperatorId:
0144
0145         The ID of the network operator that issued the SIM card,
0146         formatted as a 5 or 6-digit MCC/MNC code (e.g. <literal>"310410"</literal>).
0147
0148         Since: 1.0
0149     -->
0150     <property name="OperatorIdentifier" type="s" access="read" />
0151
0152     <!--
0153         OperatorName:
0154
0155         The name of the network operator, as given by the SIM card, if known.
0156
0157         Since: 1.0
0158     -->
0159     <property name="OperatorName" type="s" access="read" />
0160
0161     <!--
0162         EmergencyNumbers:
0163
0164         List of emergency numbers programmed in the SIM card.
0165
0166         These numbers should be treated as numbers for emergency calls in
0167         addition to 112 and 911.
0168
0169         Since: 1.12
0170     -->
0171     <property name="EmergencyNumbers" type="as" access="read" />
0172
0173     <!--
0174         PreferredNetworks:
0175
0176         List of preferred networks with access technologies configured in the SIM card.
0177
0178         Each entry contains an operator id string (<literal>"MCCMNC"</literal>)
0179         consisting of 5 or 6 digits, and an
0180         <link linkend="MMModemAccessTechnology">MMModemAccessTechnology</link> mask.
0181         If the SIM card does not support access technology storage, the mask will be
0182         set to <link linkend="MM-MODEM-ACCESS-TECHNOLOGY-UNKNOWN:CAPS">
0183         MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN</link>.
0184
0185         Since: 1.18
0186     -->
0187     <property name="PreferredNetworks" type="a(su)" access="read">
0188       <annotation name="org.qtproject.QtDBus.QtTypeName" value="QVariantMap"/>
0189     </property>
0190
0191     <!--
0192         Gid1:
0193
0194         Group identifier 1evel 1.
0195
0196         Since: 1.20
0197     -->
0198     <property name="Gid1" type="ay" access="read">
0199       <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
0200     </property>
0201
0202     <!--
0203         Gid2:
0204
0205         Group identifier 1evel 2.
0206
0207         Since: 1.20
0208     -->
0209     <property name="Gid2" type="ay" access="read">
0210       <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
0211     </property>
0212
0213     <!--
0214         SimType:
0215
0216         Indicates whether the current primary SIM is a ESIM or a physical SIM,
0217         given as <link linkend="MMSimType">MMSimType</link> value.
0218
0219         Since: 1.20
0220     -->
0221     <property name="SimType" type="u" access="read" />
0222
0223     <!--
0224         EsimStatus:
0225
0226         If current SIM is ESIM then this indicates whether there
0227         is a profile or not, given as
0228         <link linkend="MMSimEsimStatus">MMSimEsimStatus</link> value.
0229
0230         Since: 1.20
0231     -->
0232     <property name="EsimStatus" type="u" access="read" />
0233
0234     <!--
0235         Removability:
0236
0237         Indicates whether the current SIM is a removable SIM or not, given as a
0238         <link linkend="MMSimRemovability">MMSimRemovability</link> value.
0239
0240         Since: 1.20
0241     -->
0242     <property name="Removability" type="u" access="read" />
0243
0244   </interface>
0245 </node>