aboutsummaryrefslogtreecommitdiff
path: root/src/backend-dbus/com.canonical.indicators.webcredentials.xml
blob: d215081237e610644eebd64972c1f5caa62918d1 (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
<node>
<!--
  com.canonical.indicators.webcredentials:
  @short_description: interface for handling login failures.

  The service implementing this interface keeps track of login failures.
  Failures are reported (usually by signon-ui) using the ReportFailure method,
  are listed in the Failures property and can be removed by calling
  RemoveFailures.

  The ClearErrorStatus method can be called to clear the error indicator from
  the system user menu.
-->
<interface name="com.canonical.indicators.webcredentials">
  <!--
    ReportFailure:
    @account-id: the libaccounts ID of the account which failed to login.
    @notification: dictionary of parameters for the OSD notification.

    Inform the service about a failing account. The @account-id is added to the
    list of the accounts in the Failures property, and a notification might be
    displayed to the user.

    The parameters currently recognized for the @notification argument are:
    - DisplayName: string, description of the account (usually it's the
      username)
  -->
  <method name="ReportFailure">
    <annotation name="com.trolltech.QtDBus.QtTypeName.In1" value="QVariantMap"/>
    <arg name="account_id" type="u" direction="in"/>
    <arg name="notification" type="a{sv}" direction="in"/>
  </method>

  <!--
    RemoveFailures:
    @account-ids: the libaccounts IDs of the accounts.

    Remove the given account IDs from the list of the failed accounts.
  -->
  <method name="RemoveFailures">
    <annotation name="com.trolltech.QtDBus.QtTypeName.In0" value="QSet&lt;uint>"/>
    <arg name="account_ids" type="au" direction="in"/>
  </method>

  <!--
    ReauthenticateAccount:
    @account-id: the libaccounts ID of the account.
    @extra-parameters: dictionary of extra parameters (typically used to
    specify a XWindowID).
    @reauthenticated: %TRUE if the account could be reauthenticated and the
    failure status has been cleared, %FALSE otherwise.

    Tries to replay the failed authentications on the account. If all of them
    succeed, then the account failure is cleared.
  -->
  <method name="ReauthenticateAccount">
    <annotation name="com.trolltech.QtDBus.QtTypeName.In1" value="QVariantMap"/>
    <arg name="account_id" type="u" direction="in"/>
    <arg name="extra_parameters" type="a{sv}" direction="in"/>
    <arg name="reauthenticated" type="b" direction="out"/>
  </method>

  <!--
    ClearErrorStatus:

    Unsets the error indicator (if any) from the system user menu.
  -->
  <method name="ClearErrorStatus"/>

  <!--
    Failures: list of the libaccounts IDs of the failing accounts.
  -->
  <property name="Failures" type="au" access="read">
    <annotation name="com.trolltech.QtDBus.QtTypeName" value="QSet&lt;uint>"/>
  </property>

  <!--
    ErrorStatus: true if the indicator should display an error status.
  -->
  <property name="ErrorStatus" type="b" access="read"/>
</interface>
</node>