summaryrefslogtreecommitdiff
path: root/spec/Account_Manager_Interface_Hidden.xml
blob: 7617540dc81091d6ca67ade41817cba8c30cc18e (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
<?xml version="1.0" ?>
<node name="/Account_Manager_Interface_Hidden"
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <tp:copyright>Copyright © 2010 Collabora Ltd.</tp:copyright>
  <tp:copyright>Copyright © 2010 Nokia Corporation</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="im.telepathy1.AccountManager.Interface.Hidden1"
      tp:causes-havoc='kind of sketchy'>
    <tp:requires interface='im.telepathy1.AccountManager'/>
    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      <p>This interface lists accounts whose <tp:dbus-ref
        namespace='imt1.Account.Interface.Hidden1'>Hidden</tp:dbus-ref>
        property is <code>True</code>.</p>
    </tp:docstring>
    <tp:added version="0.21.10">first draft</tp:added>

    <property name="ValidHiddenAccounts" type="ao" access="read"
      tp:name-for-bindings="Valid_Hidden_Accounts">
      <tp:docstring>
        A list of valid (complete, usable) <tp:dbus-ref
          namespace="im.telepathy1">Account</tp:dbus-ref>s intended
        exclusively for noninteractive applications. These accounts are not
        included in <tp:dbus-ref
          namespace='imt1'>AccountManager.ValidAccounts</tp:dbus-ref>.  Change
          notification is via
        <tp:member-ref>HiddenAccountValidityChanged</tp:member-ref>.
      </tp:docstring>
    </property>

    <property name="InvalidHiddenAccounts" type="ao" access="read"
      tp:name-for-bindings="Invalid_Hidden_Accounts">
      <tp:docstring>
        A list of incomplete or otherwise unusable <tp:dbus-ref
          namespace="im.telepathy1">Account</tp:dbus-ref>s intended
        exclusively for noninteractive applications. Change notification is via
        <tp:member-ref>HiddenAccountValidityChanged</tp:member-ref>.
      </tp:docstring>
    </property>

    <signal name="HiddenAccountRemoved"
      tp:name-for-bindings="Hidden_Account_Removed">
      <tp:docstring>
        The given account has been removed from
        <tp:member-ref>ValidHiddenAccounts</tp:member-ref> or
        <tp:member-ref>InvalidHiddenAccounts</tp:member-ref>.
      </tp:docstring>

      <arg name="Account" type="o">
        <tp:docstring>
          An Account, which must not be used any more.
        </tp:docstring>
      </arg>
    </signal>

    <signal name="HiddenAccountValidityChanged"
      tp:name-for-bindings="Hidden_Account_Validity_Changed">
      <tp:docstring>
        The validity of the given account has changed. New magic
        accounts are also indicated by this signal, as an account validity
        change (usually to True) on an account that did not previously exist.

        <tp:rationale>
          This is effectively change notification for the valid and invalid
          accounts lists.
        </tp:rationale>
      </tp:docstring>

      <arg name="Account" type="o">
        <tp:docstring>
          An <tp:dbus-ref
            namespace="im.telepathy1">Account</tp:dbus-ref>.
        </tp:docstring>
      </arg>

      <arg name="Valid" type="b">
        <tp:docstring>
          True if the account is now valid.
        </tp:docstring>
      </arg>
    </signal>

  </interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->