~ubuntu-branches/ubuntu/utopic/telepathy-python/utopic

« back to all changes in this revision

Viewing changes to spec/Account_Manager.xml

  • Committer: Bazaar Package Importer
  • Author(s): Laurent Bigonville
  • Date: 2009-06-16 11:23:44 UTC
  • mfrom: (1.1.14 upstream) (8.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090616112344-sslc71m4xns7uv8i
Tags: 0.15.8-1
* New upstream release.
* debian/control:
  - Change package priority to optional
  - Bump Standards-Version to 3.8.1 (no further changes)
  - Be more verbose in package extended description

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<?xml version="1.0" ?>
2
2
<node name="/Account_Manager"
3
3
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4
 
  <tp:copyright>Copyright (C) 2008-2009 Collabora Ltd.</tp:copyright>
5
 
  <tp:copyright>Copyright (C) 2008-2009 Nokia Corporation</tp:copyright>
 
4
  <tp:copyright>Copyright © 2008-2009 Collabora Ltd.</tp:copyright>
 
5
  <tp:copyright>Copyright © 2008-2009 Nokia Corporation</tp:copyright>
6
6
  <tp:license xmlns="http://www.w3.org/1999/xhtml">
7
7
<p>This library is free software; you can redistribute it and/or
8
8
modify it under the terms of the GNU Lesser General Public
127
127
      </arg>
128
128
    </signal>
129
129
 
 
130
    <property name="SupportedAccountProperties"
 
131
      tp:name-for-bindings="Supported_Account_Properties"
 
132
      type="as" tp:type="DBus_Qualified_Member[]" access="read">
 
133
      <tp:added version="0.17.24"/>
 
134
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
135
        <p>A list of the fully qualified names of properties that can be set
 
136
          via the Properties argument to
 
137
          <tp:member-ref>CreateAccount</tp:member-ref> when an account is
 
138
          created.</p>
 
139
 
 
140
        <tp:rationale>
 
141
          <p>Examples of good properties to support here include
 
142
            <tp:dbus-ref
 
143
              namespace="org.freedesktop.Telepathy.Account">Icon</tp:dbus-ref>,
 
144
            <tp:dbus-ref
 
145
              namespace="org.freedesktop.Telepathy.Account">Enabled</tp:dbus-ref>,
 
146
            <tp:dbus-ref
 
147
              namespace="org.freedesktop.Telepathy.Account">Nickname</tp:dbus-ref>,
 
148
            <tp:dbus-ref
 
149
              namespace="org.freedesktop.Telepathy.Account">AutomaticPresence</tp:dbus-ref>,
 
150
            <tp:dbus-ref
 
151
              namespace="org.freedesktop.Telepathy.Account">ConnectAutomatically</tp:dbus-ref>,
 
152
            <tp:dbus-ref
 
153
              namespace="org.freedesktop.Telepathy.Account">RequestedPresence</tp:dbus-ref>
 
154
            and
 
155
            <tp:dbus-ref
 
156
              namespace="org.freedesktop.Telepathy.Account.Interface.Avatar">Avatar</tp:dbus-ref>.
 
157
            </p>
 
158
 
 
159
          <p>Examples of properties that would make no sense here include
 
160
            <tp:dbus-ref
 
161
              namespace="org.freedesktop.Telepathy.Account">Valid</tp:dbus-ref>,
 
162
            <tp:dbus-ref
 
163
              namespace="org.freedesktop.Telepathy.Account">Connection</tp:dbus-ref>,
 
164
            <tp:dbus-ref
 
165
              namespace="org.freedesktop.Telepathy.Account">ConnectionStatus</tp:dbus-ref>,
 
166
            <tp:dbus-ref
 
167
              namespace="org.freedesktop.Telepathy.Account">ConnectionStatusReason</tp:dbus-ref>,
 
168
            <tp:dbus-ref
 
169
              namespace="org.freedesktop.Telepathy.Account">CurrentPresence</tp:dbus-ref>
 
170
            and
 
171
            <tp:dbus-ref
 
172
              namespace="org.freedesktop.Telepathy.Account">NormalizedName</tp:dbus-ref>.
 
173
          </p>
 
174
        </tp:rationale>
 
175
 
 
176
        <p>This property MUST NOT include include the <tp:dbus-ref
 
177
            namespace="org.freedesktop.Telepathy.Account">DisplayName</tp:dbus-ref>
 
178
          and <tp:dbus-ref
 
179
            namespace="org.freedesktop.Telepathy.Account">Parameters</tp:dbus-ref>
 
180
          properties, which are set using separate arguments.</p>
 
181
 
 
182
        <p>This property MAY include the names of properties that, after
 
183
          account creation, will be read-only: this indicates that the property
 
184
          can be set at account creation but not changed later.</p>
 
185
 
 
186
        <tp:rationale>
 
187
          <p>For example, an account manager might support migration tools that
 
188
            use this to preserve the <tp:dbus-ref
 
189
              namespace="org.freedesktop.Telepathy.Account">HasBeenOnline</tp:dbus-ref>
 
190
            property, even though that property is usually read-only.</p>
 
191
        </tp:rationale>
 
192
      </tp:docstring>
 
193
    </property>
 
194
 
130
195
    <method name="CreateAccount" tp:name-for-bindings="Create_Account">
131
196
      <tp:docstring>
132
197
        Request the creation of a new <tp:dbus-ref
133
198
          namespace="org.freedesktop.Telepathy">Account</tp:dbus-ref>. The
134
199
        account manager SHOULD NOT allow invalid accounts to be created.
135
200
      </tp:docstring>
 
201
      <tp:changed version="0.17.24">added the Properties argument</tp:changed>
136
202
 
137
203
      <arg name="Connection_Manager" direction="in" type="s"
138
204
        tp:type="Connection_Manager_Name">
152
218
          property. The account manager SHOULD modify this to make it unique if
153
219
          an Account already exists with the same display name, for instance by
154
220
          appending a number or the 'account' parameter. Account manager
155
 
          implementations SHOULD accept an empty string but account editing user
156
 
          interfaces should avoid passing an empty string for this parameter.
 
221
          implementations SHOULD accept an empty string, but account editing
 
222
          user interfaces should avoid passing an empty string for this
 
223
          parameter.
157
224
 
158
225
          <tp:rationale>
159
226
            <p>The account creation UI may ask the user for a name for the new
176
243
            namespace="org.freedesktop.Telepathy.ConnectionManager">RequestConnection</tp:dbus-ref>.</tp:docstring>
177
244
      </arg>
178
245
 
 
246
      <arg name="Properties" direction="in" type="a{sv}"
 
247
        tp:type="Qualified_Property_Value_Map">
 
248
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
249
          <p>The values of any other properties to be set immediately on the
 
250
            new Account.</p>
 
251
 
 
252
          <p>Only the properties mentioned in
 
253
            <tp:member-ref>SupportedAccountProperties</tp:member-ref> are
 
254
            acceptable here. In particular, the <tp:dbus-ref
 
255
              namespace="org.freedesktop.Telepathy.Account">DisplayName</tp:dbus-ref>
 
256
            and <tp:dbus-ref
 
257
              namespace="org.freedesktop.Telepathy.Account">Parameters</tp:dbus-ref>
 
258
            properties are never allowed here, since they are set using the other
 
259
            arguments to this method.</p>
 
260
 
 
261
          <p>Account manager implementations SHOULD support creating accounts
 
262
            with an empty value for this argument.</p>
 
263
        </tp:docstring>
 
264
      </arg>
 
265
 
179
266
      <arg name="Account" direction="out" type="o">
180
267
        <tp:docstring>The new <tp:dbus-ref
181
268
          namespace="org.freedesktop.Telepathy">Account</tp:dbus-ref>.</tp:docstring>
183
270
 
184
271
      <tp:possible-errors>
185
272
        <tp:error name="org.freedesktop.Telepathy.Error.NotImplemented">
186
 
          <tp:docstring>The connection manager is not installed or does not
187
 
            implement that protocol.</tp:docstring>
 
273
          <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
274
            <p>The Connection_Manager is not installed or does not
 
275
              implement the given Protocol, or one of the properties in the
 
276
              Properties argument is unsupported.</p>
 
277
          </tp:docstring>
188
278
        </tp:error>
189
279
        <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument">
190
 
          <tp:docstring>The parameters provided omit a required argument
191
 
            or provide unsupported arguments.
 
280
          <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
281
            <p>The Parameters provided omit a required parameter
 
282
              or provide unsupported parameter, or the type of one
 
283
              of the Parameters or Properties is inappropriate.</p>
192
284
          </tp:docstring>
193
285
        </tp:error>
194
286
      </tp:possible-errors>