summaryrefslogtreecommitdiff
path: root/docs/polkit
diff options
context:
space:
mode:
authorDavid Zeuthen <davidz@redhat.com>2011-02-23 16:45:59 -0500
committerDavid Zeuthen <davidz@redhat.com>2011-02-23 16:45:59 -0500
commit76792accc8c846059b551dfba91ec3cd24d45d71 (patch)
tree77c4ba4614082a256f862adc536491a1c10daf2e /docs/polkit
parentf646c32853e775d87aa7147f3ad32e70a627bfce (diff)
downloadpolkit-76792accc8c846059b551dfba91ec3cd24d45d71.tar.gz
Allow overriding message shown in authentication dialog
This is much easier than writing a PolkitBackendActionLookup class and installing an extension. On the downside it requires the caller to be uid 0. Example: http://people.freedesktop.org/~david/polkit-pass-messages.png Signed-off-by: David Zeuthen <davidz@redhat.com>
Diffstat (limited to 'docs/polkit')
-rw-r--r--docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml b/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml
index b67225e..ee29c4c 100644
--- a/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml
+++ b/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.Authority.xml
@@ -596,6 +596,19 @@ Identifier for the action that <parameter>subject</parameter> is attempting to d
<para>
Details describing the action. Keys starting with <literal>polkit.</literal> are reserved for internal use and cannot be used.
</para>
+ <para>
+ Known keys include <literal>polkit.message</literal> and
+ <literal>polkit.message.gettext-domain</literal> that can be
+ used to override the message shown to the user (the user might
+ be running an authentication agent in another locale than the
+ calling process so that's why both the message and gettext
+ domain is needed.
+ </para>
+ <para>
+ If non-empty, then the request will fail with
+ <link linkend="eggdbus-constant-Error.org.freedesktop.PolicyKit1.Error.Failed">org.freedesktop.PolicyKit1.Error.Failed</link>
+ unless the process doing the check itsef is sufficiently authorized (e.g. running as uid 0).
+ </para>
</listitem>
</varlistentry>
<varlistentry>