← Back to branch summary

~unity8-desktop-session-team/indicator-session/indicator-session-using-upstart

« back to all changes in this revision

Viewing changes to src/org.freedesktop.Accounts.xml

  • Committer: Charles Kerr
  • Date: 2012-08-22 06:31:53 UTC
  • Revision ID: charles.kerr@canonical.com-20120822063153-ezwmbzyfr0waf99i
Tags: 12.10.1
12.10.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/org.freedesktop.Accounts.xml
 
1
<!DOCTYPE node PUBLIC
 
2
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
 
3
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" >
 
4
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
 
5
  <interface name="org.freedesktop.Accounts">
 
6
 
 
7
    <!-- ************************************************************ -->
 
8
 
 
9
    <method name="ListCachedUsers">
 
10
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
11
      <arg name="users" direction="out" type="ao">
 
12
        <doc:doc><doc:summary>Object paths of cached users</doc:summary></doc:doc>
 
13
      </arg>
 
14
 
 
15
      <doc:doc>
 
16
        <doc:description>
 
17
          <doc:para>
 
18
            Lists users which have logged into the system locally before.
 
19
            This is not meant to return an exhaustive list of all users.
 
20
            It is possible for <doc:ref type="method" to="Accounts.FindUserByName">FindUserByName()</doc:ref>
 
21
            to return a user that's not on the list.
 
22
          </doc:para>
 
23
        </doc:description>
 
24
      </doc:doc>
 
25
    </method>
 
26
 
 
27
    <method name="FindUserById">
 
28
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
29
      <arg name="id" direction="in" type="x">
 
30
        <doc:doc><doc:summary>The uid to look up</doc:summary></doc:doc>
 
31
      </arg>
 
32
      <arg name="user" direction="out" type="o">
 
33
        <doc:doc><doc:summary>Object path of user</doc:summary></doc:doc>
 
34
      </arg>
 
35
 
 
36
      <doc:doc>
 
37
        <doc:description>
 
38
          <doc:para>
 
39
            Finds a user by uid.
 
40
          </doc:para>
 
41
        </doc:description>
 
42
        <doc:errors>
 
43
          <doc:error name="org.freedesktop.Accounts.Error.Failed">if no user with the given uid exists</doc:error>
 
44
        </doc:errors>
 
45
      </doc:doc>
 
46
    </method>
 
47
 
 
48
    <method name="FindUserByName">
 
49
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
50
      <arg name="name" direction="in" type="s">
 
51
        <doc:doc><doc:summary>The username to look up</doc:summary></doc:doc>
 
52
      </arg>
 
53
      <arg name="user" direction="out" type="o">
 
54
        <doc:doc><doc:summary>Object path of user</doc:summary></doc:doc>
 
55
      </arg>
 
56
 
 
57
      <doc:doc>
 
58
        <doc:description>
 
59
          <doc:para>
 
60
            Finds a user by its username.
 
61
          </doc:para>
 
62
        </doc:description>
 
63
        <doc:errors>
 
64
          <doc:error name="org.freedesktop.Accounts.Error.Failed">if no user with the given username exists</doc:error>
 
65
        </doc:errors>
 
66
      </doc:doc>
 
67
    </method>
 
68
 
 
69
    <method name="CreateUser">
 
70
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
71
      <arg name="name" direction="in" type="s">
 
72
        <doc:doc><doc:summary>The username for the new user</doc:summary></doc:doc>
 
73
      </arg>
 
74
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
75
      <arg name="fullname" direction="in" type="s">
 
76
        <doc:doc><doc:summary>The real name for the new user</doc:summary></doc:doc>
 
77
      </arg>
 
78
      <arg name="user" direction="out" type="o">
 
79
        <doc:doc><doc:summary>Object path of the new user</doc:summary></doc:doc>
 
80
      </arg>
 
81
      <arg name="accountType" direction="in" type="i">
 
82
        <doc:doc>
 
83
          <doc:summary>The account type, encoded as an integer</doc:summary>
 
84
        </doc:doc>
 
85
      </arg>
 
86
      <doc:doc>
 
87
        <doc:description>
 
88
          <doc:para>
 
89
            Creates a new user account.
 
90
          </doc:para>
 
91
          <doc:para>
 
92
          The accountType argument can take the following values:
 
93
          </doc:para>
 
94
            <doc:list>
 
95
              <doc:item>
 
96
                <doc:term>0</doc:term>
 
97
                <doc:definition>Standard user</doc:definition>
 
98
              </doc:item>
 
99
              <doc:item>
 
100
                <doc:term>1</doc:term>
 
101
                <doc:definition>Administrator</doc:definition>
 
102
              </doc:item>
 
103
              <doc:item>
 
104
                <doc:term>2</doc:term>
 
105
                <doc:definition>Supervised user</doc:definition>
 
106
              </doc:item>
 
107
            </doc:list>
 
108
        </doc:description>
 
109
        <doc:permission>
 
110
          The caller needs the org.freedesktop.accounts.user-administration PolicyKit authorization.
 
111
        </doc:permission>
 
112
        <doc:errors>
 
113
          <doc:error name="org.freedesktop.Accounts.Error.PermissionDenied">if the caller lacks the appropriate PolicyKit authorization</doc:error>
 
114
          <doc:error name="org.freedesktop.Accounts.Error.Failed">if the operation failed</doc:error>
 
115
        </doc:errors>
 
116
      </doc:doc>
 
117
    </method>
 
118
 
 
119
    <method name="DeleteUser">
 
120
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
121
      <arg name="id" direction="in" type="x">
 
122
        <doc:doc><doc:summary>The uid to delete</doc:summary></doc:doc>
 
123
      </arg>
 
124
      <arg name="removeFiles" direction="in" type="b">
 
125
        <doc:doc><doc:summary>Whether to remove the users files</doc:summary></doc:doc>
 
126
      </arg>
 
127
 
 
128
      <doc:doc>
 
129
        <doc:description>
 
130
          <doc:para>
 
131
            Deletes a user account.
 
132
          </doc:para>
 
133
        </doc:description>
 
134
        <doc:permission>
 
135
          The caller needs the org.freedesktop.accounts.user-administration PolicyKit authorization.
 
136
        </doc:permission>
 
137
        <doc:errors>
 
138
          <doc:error name="org.freedesktop.Accounts.Error.PermissionDenied">if the caller lacks the appropriate PolicyKit authorization</doc:error>
 
139
          <doc:error name="org.freedesktop.Accounts.Error.Failed">if the operation failed</doc:error>
 
140
        </doc:errors>
 
141
      </doc:doc>
 
142
    </method>
 
143
 
 
144
    <signal name="UserAdded">
 
145
      <arg name="user" type="o">
 
146
        <doc:doc><doc:summary>Object path of the user that was added.</doc:summary></doc:doc>
 
147
      </arg>
 
148
      <doc:doc>
 
149
        <doc:description>
 
150
          <doc:para>
 
151
            Emitted when a user is added.
 
152
          </doc:para>
 
153
        </doc:description>
 
154
      </doc:doc>
 
155
    </signal>
 
156
 
 
157
    <signal name="UserDeleted">
 
158
      <arg name="user" type="o">
 
159
        <doc:doc><doc:summary>Object path of the user that was deleted.</doc:summary></doc:doc>
 
160
      </arg>
 
161
      <doc:doc>
 
162
        <doc:description>
 
163
          <doc:para>
 
164
            Emitted when a user is deleted.
 
165
          </doc:para>
 
166
        </doc:description>
 
167
      </doc:doc>
 
168
    </signal>
 
169
 
 
170
    <signal name="UserChanged">
 
171
      <arg name="user" type="o">
 
172
        <doc:doc><doc:summary>Object path of the user that was changed.</doc:summary></doc:doc>
 
173
      </arg>
 
174
      <doc:doc>
 
175
        <doc:description>
 
176
          <doc:para>
 
177
            Emitted when a user is changed.
 
178
          </doc:para>
 
179
        </doc:description>
 
180
      </doc:doc>
 
181
    </signal>
 
182
 
 
183
   <property name="DaemonVersion" type="s" access="read">
 
184
     <doc:doc>
 
185
       <doc:description>
 
186
         <doc:para>
 
187
           The version of the running daemon.
 
188
         </doc:para>
 
189
       </doc:description>
 
190
     </doc:doc>
 
191
   </property>
 
192
 
 
193
  </interface>
 
194
</node>