ACC SHELL
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Actions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="PolicyKit Library Reference Manual">
<link rel="up" href="ref-core.html" title="Core API Reference">
<link rel="prev" href="polkit-Results.html" title="Results">
<link rel="next" href="polkit-Seat.html" title="Seat">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="polkit-Results.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ref-core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">PolicyKit Library Reference Manual</th>
<td><a accesskey="n" href="polkit-Seat.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#polkit-Actions.synopsis" class="shortcut">Top</a>
|
<a href="#polkit-Actions.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Actions">
<a name="polkit-Actions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="polkit-Actions.top_of_page"></a>Actions</span></h2>
<p>Actions — Models what a caller is attempting to do.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="polkit-Actions.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction">PolKitAction</a>;
<a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="returnvalue">PolKitAction</span></a> * <a class="link" href="polkit-Actions.html#polkit-action-new" title="polkit_action_new ()">polkit_action_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="returnvalue">PolKitAction</span></a> * <a class="link" href="polkit-Actions.html#polkit-action-ref" title="polkit_action_ref ()">polkit_action_ref</a> (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);
<span class="returnvalue">void</span> <a class="link" href="polkit-Actions.html#polkit-action-unref" title="polkit_action_unref ()">polkit_action_unref</a> (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);
<a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> <a class="link" href="polkit-Actions.html#polkit-action-set-action-id" title="polkit_action_set_action_id ()">polkit_action_set_action_id</a> (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *action_id</code></em>);
<a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> <a class="link" href="polkit-Actions.html#polkit-action-get-action-id" title="polkit_action_get_action_id ()">polkit_action_get_action_id</a> (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>,
<em class="parameter"><code><span class="type">char</span> **out_action_id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="polkit-Actions.html#polkit-action-debug" title="polkit_action_debug ()">polkit_action_debug</a> (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);
<a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> <a class="link" href="polkit-Actions.html#polkit-action-validate" title="polkit_action_validate ()">polkit_action_validate</a> (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);
<a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> <a class="link" href="polkit-Actions.html#polkit-action-validate-id" title="polkit_action_validate_id ()">polkit_action_validate_id</a> (<em class="parameter"><code>const <span class="type">char</span> *action_id</code></em>);
<a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> <a class="link" href="polkit-Actions.html#polkit-action-equal" title="polkit_action_equal ()">polkit_action_equal</a> (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *a</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *b</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="polkit-Actions.html#polkit-action-to-string-representation" title="polkit_action_to_string_representation ()">polkit_action_to_string_representation</a>
(<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);
<a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="returnvalue">PolKitAction</span></a> * <a class="link" href="polkit-Actions.html#polkit-action-new-from-string-representation" title="polkit_action_new_from_string_representation ()">polkit_action_new_from_string_representation</a>
(<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="polkit-Actions.description"></a><h2>Description</h2>
<p>
This class is used to represent a PolicyKit action.
</p>
</div>
<div class="refsect1" title="Details">
<a name="polkit-Actions.details"></a><h2>Details</h2>
<div class="refsect2" title="PolKitAction">
<a name="PolKitAction"></a><h3>PolKitAction</h3>
<pre class="programlisting">typedef struct _PolKitAction PolKitAction;</pre>
<p>
Objects of this class are used to record information about an action.
</p>
</div>
<hr>
<div class="refsect2" title="polkit_action_new ()">
<a name="polkit-action-new"></a><h3>polkit_action_new ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="returnvalue">PolKitAction</span></a> * polkit_action_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new <a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the new object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_action_ref ()">
<a name="polkit-action-ref"></a><h3>polkit_action_ref ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="returnvalue">PolKitAction</span></a> * polkit_action_ref (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);</pre>
<p>
Increase reference count.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the action object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_action_unref ()">
<a name="polkit-action-unref"></a><h3>polkit_action_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> polkit_action_unref (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);</pre>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the action object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_action_set_action_id ()">
<a name="polkit-action-set-action-id"></a><h3>polkit_action_set_action_id ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> polkit_action_set_action_id (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *action_id</code></em>);</pre>
<p>
Set the action identifier
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the action object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_id</code></em> :</span></p></td>
<td>action identifier
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> only if the value validated and was set
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_action_get_action_id ()">
<a name="polkit-action-get-action-id"></a><h3>polkit_action_get_action_id ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> polkit_action_get_action_id (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>,
<em class="parameter"><code><span class="type">char</span> **out_action_id</code></em>);</pre>
<p>
Get the action identifier.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the action object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_action_id</code></em> :</span></p></td>
<td>Returns the action identifier. The caller shall not free this string.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE iff the value was returned.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_action_debug ()">
<a name="polkit-action-debug"></a><h3>polkit_action_debug ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> polkit_action_debug (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);</pre>
<p>
Print debug details
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_action_validate ()">
<a name="polkit-action-validate"></a><h3>polkit_action_validate ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> polkit_action_validate (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);</pre>
<p>
Validate the object
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> iff the object is valid.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_action_validate_id ()">
<a name="polkit-action-validate-id"></a><h3>polkit_action_validate_id ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> polkit_action_validate_id (<em class="parameter"><code>const <span class="type">char</span> *action_id</code></em>);</pre>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_id</code></em> :</span></p></td>
<td>the action identifier to validate
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> iff the action identifier is well formed
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_action_equal ()">
<a name="polkit-action-equal"></a><h3>polkit_action_equal ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a> polkit_action_equal (<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *a</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *b</code></em>);</pre>
<p>
Test if <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> refer to the same action.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
<td>first action
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
<td>second action
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> iff <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> refer to the same action.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2" title="polkit_action_to_string_representation ()">
<a name="polkit-action-to-string-representation"></a><h3>polkit_action_to_string_representation ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * polkit_action_to_string_representation
(<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);</pre>
<p>
Serializes <em class="parameter"><code>action</code></em> into a textual form that can be transferred from
process to process or saved on disk. Use
<a class="link" href="polkit-Actions.html#polkit-action-new-from-string-representation" title="polkit_action_new_from_string_representation ()"><code class="function">polkit_action_new_from_string_representation()</code></a> to deserialize it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the action object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A string representation of <em class="parameter"><code>action</code></em> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if the action
is not valid. String is valid until <em class="parameter"><code>action</code></em> is freed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2" title="polkit_action_new_from_string_representation ()">
<a name="polkit-action-new-from-string-representation"></a><h3>polkit_action_new_from_string_representation ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="returnvalue">PolKitAction</span></a> * polkit_action_new_from_string_representation
(<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
<p>
Creates a new <a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> object from a textual representation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>textual representation of an action; typically obtained from
<a class="link" href="polkit-Actions.html#polkit-action-to-string-representation" title="polkit_action_to_string_representation ()"><code class="function">polkit_action_to_string_representation()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> object or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if OOM or if the
representation isn't valid. Caller must free this object with
<a class="link" href="polkit-Actions.html#polkit-action-unref" title="polkit_action_unref ()"><code class="function">polkit_action_unref()</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
ACC SHELL 2018