org.freedesktop.PolicyKit1.Authority.xml 4.64 KB
Newer Older
David Zeuthen's avatar
David Zeuthen committed
1 2 3 4
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>

5
  <!-- Subject struct -->
6
  <annotation name="org.gtk.EggDBus.DeclareStruct" value="Subject">
7

8 9 10
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="s:subject_kind">
      <annotation name="org.gtk.EggDBus.DocString" value="Kind of subject"/>
    </annotation>
11

12 13 14
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="a{sv}:subject_details">
      <annotation name="org.gtk.EggDBus.DocString" value="Details about the subject"/>
    </annotation>
15

16
    <!-- TODO: document values in hash map for each subject type-->
17

18 19
  </annotation>

20
  <!-- ActionDescription struct -->
21 22
  <annotation name="org.gtk.EggDBus.DeclareStruct" value="ActionDescription">

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="s:action_id">
      <annotation name="org.gtk.EggDBus.DocString" value="Action Identifier"/>
    </annotation>
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="s:description">
      <annotation name="org.gtk.EggDBus.DocString" value="Action Description"/>
    </annotation>
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="s:message">
      <annotation name="org.gtk.EggDBus.DocString" value="Action Message"/>
    </annotation>
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="s:vendor_name">
      <annotation name="org.gtk.EggDBus.DocString" value="Vendor Name"/>
    </annotation>
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="s:vendor_url">
      <annotation name="org.gtk.EggDBus.DocString" value="Vendor URL"/>
    </annotation>
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="s:icon_name">
      <annotation name="org.gtk.EggDBus.DocString" value="Icon Name"/>
    </annotation>
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="a{ss}:annotations">
      <annotation name="org.gtk.EggDBus.DocString" value="Annotations"/>
    </annotation>
44 45 46 47 48

    <!-- TODO: also include defaults -->

  </annotation>

49
  <!-- AuthorizationClaim struct -->
50
  <annotation name="org.gtk.EggDBus.DeclareStruct" value="AuthorizationClaim">
51 52 53
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="(sa{sv}):subject">
      <annotation name="org.gtk.EggDBus.DocString" value="Subject the claim is for"/>
    </annotation>
54

55 56 57
    <annotation name="org.gtk.EggDBus.Struct.Member"  value="s:action_id">
      <annotation name="org.gtk.EggDBus.DocString" value="Action Identifier for the claim"/>
    </annotation>
58 59
  </annotation>

60
  <!-- The error domain used for reporting errors -->
61 62 63 64 65 66 67
  <annotation name="org.gtk.EggDBus.DeclareErrorDomain" value="Error">
    <annotation name="org.gtk.EggDBus.ErrorDomain.Member" value="org.freedesktop.PolicyKit1.Error.Failed">
      <annotation name="org.gtk.EggDBus.DocString" value="The operation failed"/>
    </annotation>
    <annotation name="org.gtk.EggDBus.ErrorDomain.Member" value="org.freedesktop.PolicyKit1.Error.NotSupported">
      <annotation name="org.gtk.EggDBus.DocString" value="Operation is not supported"/>
    </annotation>
David Zeuthen's avatar
David Zeuthen committed
68
  </annotation>
David Zeuthen's avatar
David Zeuthen committed
69

70
  <!-- An enumeration for results of CheckClaim() (TODO: implement this method) -->
71 72 73 74 75 76 77 78 79 80 81 82 83
  <annotation name="org.gtk.EggDBus.DeclareEnum" value="AuthorizationResult">
    <annotation name="org.gtk.EggDBus.Enum.Member" value="NotAuthorized">
      <annotation name="org.gtk.EggDBus.DocString" value="The subject is not authorized for the specified action"/>
    </annotation>
    <annotation name="org.gtk.EggDBus.Enum.Member" value="Authorized">
      <annotation name="org.gtk.EggDBus.DocString" value="The subject is authorized for the specified action"/>
    </annotation>
    <annotation name="org.gtk.EggDBus.Enum.Member" value="Challenge">
      <annotation name="org.gtk.EggDBus.DocString" value="The subject is authorized if more information is provided"/>
    </annotation>
  </annotation>


David Zeuthen's avatar
David Zeuthen committed
84 85
  <interface name="org.freedesktop.PolicyKit1.Authority">

David Zeuthen's avatar
David Zeuthen committed
86 87
    <method name="EnumerateUsers">
      <arg name="users" direction="out" type="a(sa{sv})"/>
David Zeuthen's avatar
David Zeuthen committed
88 89
    </method>

90 91 92 93
    <method name="EnumerateGroups">
      <arg name="groups" direction="out" type="a(sa{sv})"/>
    </method>

94 95 96 97 98
    <method name="EnumerateActions">
      <arg name="locale" direction="in" type="s"/>
      <arg name="action_descriptions" direction="out" type="a(ssssssa{ss})"/>
    </method>

99
    <method name="CheckClaim">
100
      <arg name="claim" direction="in" type="((sa{sv})s)">
101 102 103 104 105 106 107
        <annotation name="org.gtk.EggDBus.StructType" value="AuthorizationClaim"/>
      </arg>
      <arg name="result" direction="out" type="i">
        <annotation name="org.gtk.EggDBus.EnumType" value="AuthorizationResult"/>
      </arg>
    </method>

David Zeuthen's avatar
David Zeuthen committed
108 109
  </interface>
</node>