aboutsummaryrefslogtreecommitdiff
path: root/src/backend-dbus/com.canonical.indicators.webcredentials.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/backend-dbus/com.canonical.indicators.webcredentials.xml')
-rw-r--r--src/backend-dbus/com.canonical.indicators.webcredentials.xml82
1 files changed, 82 insertions, 0 deletions
diff --git a/src/backend-dbus/com.canonical.indicators.webcredentials.xml b/src/backend-dbus/com.canonical.indicators.webcredentials.xml
new file mode 100644
index 0000000..d215081
--- /dev/null
+++ b/src/backend-dbus/com.canonical.indicators.webcredentials.xml
@@ -0,0 +1,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>