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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="polkit-polkit-action">
<refmeta>
<refentrytitle role="top_of_page" id="polkit-polkit-action.top_of_page">Actions</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>POLKIT Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Actions</refname>
<refpurpose>Models what a caller is attempting to do.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="polkit-polkit-action.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="PolKitAction">PolKitAction</link>;
<link linkend="PolKitAction">PolKitAction</link>* <link linkend="polkit-action-new">polkit_action_new</link> (void);
<link linkend="PolKitAction">PolKitAction</link>* <link linkend="polkit-action-ref">polkit_action_ref</link> (<link linkend="PolKitAction">PolKitAction</link> *action);
<link linkend="void">void</link> <link linkend="polkit-action-unref">polkit_action_unref</link> (<link linkend="PolKitAction">PolKitAction</link> *action);
<link linkend="polkit-bool-t">polkit_bool_t</link> <link linkend="polkit-action-set-action-id">polkit_action_set_action_id</link> (<link linkend="PolKitAction">PolKitAction</link> *action,
const <link linkend="char">char</link> *action_id);
<link linkend="polkit-bool-t">polkit_bool_t</link> <link linkend="polkit-action-get-action-id">polkit_action_get_action_id</link> (<link linkend="PolKitAction">PolKitAction</link> *action,
<link linkend="char">char</link> **out_action_id);
<link linkend="void">void</link> <link linkend="polkit-action-debug">polkit_action_debug</link> (<link linkend="PolKitAction">PolKitAction</link> *action);
<link linkend="polkit-bool-t">polkit_bool_t</link> <link linkend="polkit-action-validate">polkit_action_validate</link> (<link linkend="PolKitAction">PolKitAction</link> *action);
<link linkend="polkit-bool-t">polkit_bool_t</link> <link linkend="polkit-action-validate-id">polkit_action_validate_id</link> (const <link linkend="char">char</link> *action_id);
<link linkend="polkit-bool-t">polkit_bool_t</link> <link linkend="polkit-action-equal">polkit_action_equal</link> (<link linkend="PolKitAction">PolKitAction</link> *a,
<link linkend="PolKitAction">PolKitAction</link> *b);
const <link linkend="char">char</link>* <link linkend="polkit-action-to-string-representation">polkit_action_to_string_representation</link>
(<link linkend="PolKitAction">PolKitAction</link> *action);
<link linkend="PolKitAction">PolKitAction</link>* <link linkend="polkit-action-new-from-string-representation">polkit_action_new_from_string_representation</link>
(const <link linkend="char">char</link> *str);
</synopsis>
</refsynopsisdiv>
<refsect1 id="polkit-polkit-action.description" role="desc">
<title role="desc.title">Description</title>
<para>
This class is used to represent a PolicyKit action.</para>
<para>
</para>
</refsect1>
<refsect1 id="polkit-polkit-action.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="PolKitAction" role="struct">
<title>PolKitAction</title>
<indexterm zone="PolKitAction"><primary>PolKitAction</primary></indexterm><programlisting>typedef struct _PolKitAction PolKitAction;</programlisting>
<para>
Objects of this class are used to record information about an action.</para>
<para>
</para></refsect2>
<refsect2 id="polkit-action-new" role="function">
<title>polkit_action_new ()</title>
<indexterm zone="polkit-action-new"><primary>polkit_action_new</primary></indexterm><programlisting><link linkend="PolKitAction">PolKitAction</link>* polkit_action_new (void);</programlisting>
<para>
Create a new <link linkend="PolKitAction"><type>PolKitAction</type></link> object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-action-ref" role="function">
<title>polkit_action_ref ()</title>
<indexterm zone="polkit-action-ref"><primary>polkit_action_ref</primary></indexterm><programlisting><link linkend="PolKitAction">PolKitAction</link>* polkit_action_ref (<link linkend="PolKitAction">PolKitAction</link> *action);</programlisting>
<para>
Increase reference count.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter> :</term>
<listitem><simpara> the action object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-action-unref" role="function">
<title>polkit_action_unref ()</title>
<indexterm zone="polkit-action-unref"><primary>polkit_action_unref</primary></indexterm><programlisting><link linkend="void">void</link> polkit_action_unref (<link linkend="PolKitAction">PolKitAction</link> *action);</programlisting>
<para>
Decreases the reference count of the object. If it becomes zero,
the object is freed. Before freeing, reference counts on embedded
objects are decresed by one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter> :</term>
<listitem><simpara> the action object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-action-set-action-id" role="function">
<title>polkit_action_set_action_id ()</title>
<indexterm zone="polkit-action-set-action-id"><primary>polkit_action_set_action_id</primary></indexterm><programlisting><link linkend="polkit-bool-t">polkit_bool_t</link> polkit_action_set_action_id (<link linkend="PolKitAction">PolKitAction</link> *action,
const <link linkend="char">char</link> *action_id);</programlisting>
<para>
Set the action identifier</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter> :</term>
<listitem><simpara> the action object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>action_id</parameter> :</term>
<listitem><simpara> action identifier
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> only if the value validated and was set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-action-get-action-id" role="function">
<title>polkit_action_get_action_id ()</title>
<indexterm zone="polkit-action-get-action-id"><primary>polkit_action_get_action_id</primary></indexterm><programlisting><link linkend="polkit-bool-t">polkit_bool_t</link> polkit_action_get_action_id (<link linkend="PolKitAction">PolKitAction</link> *action,
<link linkend="char">char</link> **out_action_id);</programlisting>
<para>
Get the action identifier.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter> :</term>
<listitem><simpara> the action object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out_action_id</parameter> :</term>
<listitem><simpara> Returns the action identifier. The caller shall not free this string.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE iff the value was returned.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-action-debug" role="function">
<title>polkit_action_debug ()</title>
<indexterm zone="polkit-action-debug"><primary>polkit_action_debug</primary></indexterm><programlisting><link linkend="void">void</link> polkit_action_debug (<link linkend="PolKitAction">PolKitAction</link> *action);</programlisting>
<para>
Print debug details</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter> :</term>
<listitem><simpara> the object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-action-validate" role="function">
<title>polkit_action_validate ()</title>
<indexterm zone="polkit-action-validate"><primary>polkit_action_validate</primary></indexterm><programlisting><link linkend="polkit-bool-t">polkit_bool_t</link> polkit_action_validate (<link linkend="PolKitAction">PolKitAction</link> *action);</programlisting>
<para>
Validate the object</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter> :</term>
<listitem><simpara> the object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> iff the object is valid.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-action-validate-id" role="function">
<title>polkit_action_validate_id ()</title>
<indexterm zone="polkit-action-validate-id"><primary>polkit_action_validate_id</primary></indexterm><programlisting><link linkend="polkit-bool-t">polkit_bool_t</link> polkit_action_validate_id (const <link linkend="char">char</link> *action_id);</programlisting>
<para>
Validate whether an action identifier is well formed. To be well
formed, an action identifier needs to start with a lower case ASCII
character and can only contain the characters "[a-z][0-9].-". It
must be less than or equal 256 bytes in length including the
terminating NUL character.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>action_id</parameter> :</term>
<listitem><simpara> the action identifier to validate
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> iff the action identifier is well formed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-action-equal" role="function" condition="since:0.8">
<title>polkit_action_equal ()</title>
<indexterm zone="polkit-action-equal" role="0.8"><primary>polkit_action_equal</primary></indexterm><programlisting><link linkend="polkit-bool-t">polkit_bool_t</link> polkit_action_equal (<link linkend="PolKitAction">PolKitAction</link> *a,
<link linkend="PolKitAction">PolKitAction</link> *b);</programlisting>
<para>
Test if <parameter>a</parameter> and <parameter>b</parameter> refer to the same action.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>a</parameter> :</term>
<listitem><simpara> first action
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>b</parameter> :</term>
<listitem><simpara> second action
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> iff <parameter>a</parameter> and <parameter>b</parameter> refer to the same action.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="polkit-action-to-string-representation" role="function" condition="since:0.8">
<title>polkit_action_to_string_representation ()</title>
<indexterm zone="polkit-action-to-string-representation" role="0.8"><primary>polkit_action_to_string_representation</primary></indexterm><programlisting>const <link linkend="char">char</link>* polkit_action_to_string_representation
(<link linkend="PolKitAction">PolKitAction</link> *action);</programlisting>
<para>
Serializes <parameter>action</parameter> into a textual form that can be transferred from
process to process or saved on disk. Use
<link linkend="polkit-action-new-from-string-representation"><function>polkit_action_new_from_string_representation()</function></link> to deserialize it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter> :</term>
<listitem><simpara> the action object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A string representation of <parameter>action</parameter> or <link linkend="NULL:CAPS"><type>NULL</type></link> if the action
is not valid. String is valid until <parameter>action</parameter> is freed.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="polkit-action-new-from-string-representation" role="function" condition="since:0.8">
<title>polkit_action_new_from_string_representation ()</title>
<indexterm zone="polkit-action-new-from-string-representation" role="0.8"><primary>polkit_action_new_from_string_representation</primary></indexterm><programlisting><link linkend="PolKitAction">PolKitAction</link>* polkit_action_new_from_string_representation
(const <link linkend="char">char</link> *str);</programlisting>
<para>
Creates a new <link linkend="PolKitAction"><type>PolKitAction</type></link> object from a textual representation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara> textual representation of an action; typically obtained from
<link linkend="polkit-action-to-string-representation"><function>polkit_action_to_string_representation()</function></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="PolKitAction"><type>PolKitAction</type></link> object or <link linkend="NULL:CAPS"><type>NULL</type></link> if OOM or if the
representation isn't valid. Caller must free this object with
<link linkend="polkit-action-unref"><function>polkit_action_unref()</function></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
</refsect1>
</refentry>
|
