summaryrefslogtreecommitdiff
path: root/spec/Account_Manager.xml
blob: 3811147c6a652e3c698dc2fbe89dbdf5980f7f81 (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
<?xml version="1.0" ?>
<node name="/Account_Manager" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <tp:copyright>Copyright © 2011 Intel Corp.</tp:copyright>
  <tp:license xmlns="http://www.w3.org/1999/xhtml">
    <p>This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.</p>

<p>This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.</p>

<p>You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
  </tp:license>
  <interface name="com.meego.xpmn.ytstenut.AccountManager">

    <property name="Account" access="read" tp:name-for-bindings="Account"
      type="o" tp:immutable='yes'>
      <tp:docstring>
        Object path for the ytstenut account.
      </tp:docstring>
    </property>

    <method name="Hold" tp:name-for-bindings="Hold">
      <tp:docstring>
        Tell the account manager that the caller of this method is using
        the ytstenut account until the caller calls
        <tp:member-ref>Release</tp:member-ref>.
      </tp:docstring>
    </method>

    <method name="Release" tp:name-for-bindings="Release">
      <tp:docstring>
        Tell the account manager that the caller is finished using the
        ytstenut account. This should only follow a successful call to
        <tp:member-ref>Hold</tp:member-ref> by the same caller.
      </tp:docstring>
    </method>

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      <p>This interface is provided by the account manager at the path
        <tt>/com/meego/xpmn/ytstenut/AccountManager</tt>.</p>

      <p>This account manager interface is used to discover the
        ytstenut account.  This account is created automatically and
        is always present.  Callers can use the
        <tp:member-ref>Hold</tp:member-ref> and
        <tp:member-ref>Release</tp:member-ref> methods to indicate
        their usage of the account. If at least one caller has
        indicated their usage of the account then the accounts
        presence will be set to available.</p>
    </tp:docstring>

  </interface>
</node>