summaryrefslogtreecommitdiff
path: root/introspection/org.freedesktop.ModemManager1.Sim.xml
blob: 3008aaf2f5ec1bcc56de1e4343c971ad737efb72 (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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<?xml version="1.0" encoding="UTF-8" ?>

<!--
 ModemManager 1.0 Interface Specification

   Copyright (C) 2011-2013 Red Hat, Inc.
   Copyright (C) 2011-2013 Google, Inc.
   Copyright (C) 2011-2013 Lanedo GmbH
-->

<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">

  <!--
      org.freedesktop.ModemManager1.Sim:
      @short_description: The ModemManager SIM interface.

      The SIM interface handles communication with SIM, USIM, and RUIM (CDMA
      SIM) cards.
  -->
  <interface name="org.freedesktop.ModemManager1.Sim">

    <!--
        SendPin:
        @pin: A string containing the PIN code.

        Send the PIN to unlock the SIM card.

        Since: 1.0
    -->
    <method name="SendPin">
      <arg name="pin" type="s" direction="in" />
    </method>

    <!--
        SendPuk:
        @puk: A string containing the PUK code.
        @pin: A string containing the PIN code.

        Send the PUK and a new PIN to unlock the SIM card.

        Since: 1.0
    -->
    <method name="SendPuk">
      <arg name="puk" type="s" direction="in" />
      <arg name="pin" type="s" direction="in" />
    </method>

    <!--
        EnablePin:
        @pin: A string containing the PIN code.
        @enabled: %TRUE to enable PIN checking, %FALSE otherwise.

        Enable or disable the PIN checking.

        Since: 1.0
    -->
    <method name="EnablePin">
      <arg name="pin"     type="s" direction="in" />
      <arg name="enabled" type="b" direction="in" />
    </method>

    <!--
        ChangePin:
        @old_pin: A string containing the current PIN code.
        @new_pin: A string containing the new PIN code.

        Change the PIN code.

        Since: 1.0
    -->
    <method name="ChangePin">
      <arg name="old_pin" type="s" direction="in" />
      <arg name="new_pin" type="s" direction="in" />
    </method>

    <!--
        SetPreferredNetworks:
        @preferred_plmns: List of preferred networks.

        Stores the provided preferred network list to the SIM card. Each entry contains
        an operator id string (<literal>"MCCMNC"</literal>) consisting of 5 or 6 digits,
        and an <link linkend="MMModemAccessTechnology">MMModemAccessTechnology</link> mask
        to store to SIM card if supported.

        This method removes any pre-existing entries of the preferred network list. Note
        that even if this operation fails, the preferred network list on the SIM card may
        have changed. Read the <link linkend="gdbus-property-org-freedesktop-ModemManager1-Sim.PreferredNetworks">
        PreferredNetworks</link> property to get the up-to-date list.

        Since: 1.18
    -->
    <method name="SetPreferredNetworks">
      <arg name="preferred_networks" type="a(su)" direction="in" />
    </method>

    <!--
        Active:

        Boolean indicating whether the SIM is currently active.

        On systems that support Multi SIM Single Standby, only one SIM may be
        active at any given time, which will be the one considered primary.

        On systems that support Multi SIM Multi Standby, more than one SIM may
        be active at any given time, but only one of them is considered primary.

        Since: 1.16
    -->
    <property name="Active" type="b" access="read" />

    <!--
        SimIdentifier:

        The ICCID of the SIM card.

        This may be available before the PIN has been entered depending
        on the device itself.

        Since: 1.0
    -->
    <property name="SimIdentifier" type="s" access="read" />

    <!--
        Imsi:

        The IMSI of the SIM card, if any.

        Since: 1.0
    -->
    <property name="Imsi" type="s" access="read" />

    <!--
        Eid:

        The EID of the SIM card, if any.

        Since: 1.16
    -->
    <property name="Eid" type="s" access="read" />

    <!--
        OperatorId:

        The ID of the network operator that issued the SIM card,
        formatted as a 5 or 6-digit MCC/MNC code (e.g. <literal>"310410"</literal>).

        Since: 1.0
    -->
    <property name="OperatorIdentifier" type="s" access="read" />

    <!--
        OperatorName:

        The name of the network operator, as given by the SIM card, if known.

        Since: 1.0
    -->
    <property name="OperatorName" type="s" access="read" />

    <!--
        EmergencyNumbers:

        List of emergency numbers programmed in the SIM card.

        These numbers should be treated as numbers for emergency calls in
        addition to 112 and 911.

        Since: 1.12
    -->
    <property name="EmergencyNumbers" type="as" access="read" />

    <!--
        PreferredNetworks:

        List of preferred networks with access technologies configured in the SIM card.

        Each entry contains an operator id string (<literal>"MCCMNC"</literal>)
        consisting of 5 or 6 digits, and an
        <link linkend="MMModemAccessTechnology">MMModemAccessTechnology</link> mask.
        If the SIM card does not support access technology storage, the mask will be
        set to <link linkend="MM-MODEM-ACCESS-TECHNOLOGY-UNKNOWN:CAPS">
        MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN</link>.

        Since: 1.18
    -->
    <property name="PreferredNetworks" type="a(su)" access="read" />

  </interface>
</node>