docs/html/tlm-TlmAccountPlugin.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>TlmAccountPlugin</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Tizen Login Manager Reference Manual">
   8 <link rel="up" href="ch02.html" title="Tlm plugins reference">
   9 <link rel="prev" href="ch02.html" title="Tlm plugins reference">
  10 <link rel="next" href="tlm-TlmAccountPluginDefault.html" title="TlmAccountPluginDefault">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="ch02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">Tizen Login Manager Reference Manual</th>
  21 <td><a accesskey="n" href="tlm-TlmAccountPluginDefault.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#tlm-TlmAccountPlugin.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#tlm-TlmAccountPlugin.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="tlm-TlmAccountPlugin"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="tlm-TlmAccountPlugin.top_of_page"></a>TlmAccountPlugin</span></h2>
  34 <p>TlmAccountPlugin — an interface for implementing tlm account plugins</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="tlm-TlmAccountPlugin.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;tlm-account-plugin.h&gt;
  42
  43 struct              <a class="link" href="tlm-TlmAccountPlugin.html#TlmAccountPluginInterface" title="struct TlmAccountPluginInterface">TlmAccountPluginInterface</a>;
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="tlm-TlmAccountPlugin.html#tlm-account-plugin-cleanup-guest-user" title="tlm_account_plugin_cleanup_guest_user ()">tlm_account_plugin_cleanup_guest_user</a>
  45                                                         (<em class="parameter"><code><span class="type">TlmAccountPlugin</span> *self</code></em>,
  46                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *user_name</code></em>,
  47                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> delete_account</code></em>);
  48 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="tlm-TlmAccountPlugin.html#tlm-account-plugin-is-valid-user" title="tlm_account_plugin_is_valid_user ()">tlm_account_plugin_is_valid_user</a>    (<em class="parameter"><code><span class="type">TlmAccountPlugin</span> *self</code></em>,
  49                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *user_name</code></em>);
  50 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="tlm-TlmAccountPlugin.html#tlm-account-plugin-setup-guest-user-account" title="tlm_account_plugin_setup_guest_user_account ()">tlm_account_plugin_setup_guest_user_account</a>
  51                                                         (<em class="parameter"><code><span class="type">TlmAccountPlugin</span> *self</code></em>,
  52                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *user_name</code></em>);
  53 </pre>
  54 </div>
  55 <div class="refsect1">
  56 <a name="tlm-TlmAccountPlugin.description"></a><h2>Description</h2>
  57 <p>
  58 <span class="type">TlmAccountPlugin</span> is an interface for implementing tlm account plugins.
  59 </p>
  60 <p>
  61 </p>
  62 <div class="refsect1">
  63 <a name="idp9699824"></a><h2>The plugin API</h2>
  64 </div>
  65 <p>
  66 </p>
  67 <p>
  68 Tlm account plugins provide an API for system-specific account operations:
  69 setting up and cleaning up guest user account, and checking username validity.
  70 They should implement the plugin interface specified here.
  71 </p>
  72 <p>
  73 </p>
  74 <div class="refsect1">
  75 <a name="idp9043392"></a><h2>Example plugins</h2>
  76 </div>
  77 <p>
  78 </p>
  79 <p>
  80 See example plugin implementation here:
  81 <a class="ulink" href="https://github.com/01org/tlm/tree/master/src/plugins/default" target="_top">
  82 https://github.com/01org/tlm/tree/master/src/plugins/default</a> and here:
  83 <a class="ulink" href="https://github.com/01org/tlm/tree/master/src/plugins/gumd" target="_top">
  84 https://github.com/01org/tlm/tree/master/src/plugins/gumd</a>.
  85 </p>
  86 </div>
  87 <div class="refsect1">
  88 <a name="tlm-TlmAccountPlugin.details"></a><h2>Details</h2>
  89 <div class="refsect2">
  90 <a name="TlmAccountPluginInterface"></a><h3>struct TlmAccountPluginInterface</h3>
  91 <pre class="programlisting">struct TlmAccountPluginInterface {
  92    GTypeInterface parent;
  93
  94     gboolean (*setup_guest_user_account) (TlmAccountPlugin *self,
  95                                           const gchar *user_name);
  96     gboolean (*is_valid_user) (TlmAccountPlugin *self,
  97                                const gchar *user_name);
  98
  99    gboolean  (*cleanup_guest_user) (TlmAccountPlugin *self,
 100                                     const gchar *guest_user,
 101                                     gboolean delete_account);
 102 };
 103 </pre>
 104 <p>
 105 <a class="link" href="tlm-TlmAccountPlugin.html#TlmAccountPluginInterface" title="struct TlmAccountPluginInterface"><span class="type">TlmAccountPluginInterface</span></a> interface containing pointers to methods that all
 106 plugin implementations should provide.
 107 </p>
 108 <div class="variablelist"><table border="0">
 109 <col align="left" valign="top">
 110 <tbody>
 111 <tr>
 112 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="TlmAccountPluginInterface.parent"></a>parent</code></em>;</span></p></td>
 113 <td>parent interface type.</td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term"><em class="structfield"><code><a name="TlmAccountPluginInterface.setup-guest-user-account"></a>setup_guest_user_account</code></em> ()</span></p></td>
 117 <td>implementation of <a class="link" href="tlm-TlmAccountPlugin.html#tlm-account-plugin-setup-guest-user-account" title="tlm_account_plugin_setup_guest_user_account ()"><code class="function">tlm_account_plugin_setup_guest_user_account()</code></a>
 118 </td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><em class="structfield"><code><a name="TlmAccountPluginInterface.is-valid-user"></a>is_valid_user</code></em> ()</span></p></td>
 122 <td>implementation of <a class="link" href="tlm-TlmAccountPlugin.html#tlm-account-plugin-is-valid-user" title="tlm_account_plugin_is_valid_user ()"><code class="function">tlm_account_plugin_is_valid_user()</code></a>
 123 </td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term"><em class="structfield"><code><a name="TlmAccountPluginInterface.cleanup-guest-user"></a>cleanup_guest_user</code></em> ()</span></p></td>
 127 <td>implementation of <a class="link" href="tlm-TlmAccountPlugin.html#tlm-account-plugin-cleanup-guest-user" title="tlm_account_plugin_cleanup_guest_user ()"><code class="function">tlm_account_plugin_cleanup_guest_user()</code></a>
 128 </td>
 129 </tr>
 130 </tbody>
 131 </table></div>
 132 </div>
 133 <hr>
 134 <div class="refsect2">
 135 <a name="tlm-account-plugin-cleanup-guest-user"></a><h3>tlm_account_plugin_cleanup_guest_user ()</h3>
 136 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tlm_account_plugin_cleanup_guest_user
 137                                                         (<em class="parameter"><code><span class="type">TlmAccountPlugin</span> *self</code></em>,
 138                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *user_name</code></em>,
 139                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> delete_account</code></em>);</pre>
 140 <p>
 141 When a guest user logs out, this method is called. It should clean up the
 142 home directory of the user, and, if delete_user is set, delete the user
 143 account.
 144 </p>
 145 <div class="variablelist"><table border="0">
 146 <col align="left" valign="top">
 147 <tbody>
 148 <tr>
 149 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 150 <td>plugin instance</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term"><em class="parameter"><code>user_name</code></em> :</span></p></td>
 154 <td>user name to clean up</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><em class="parameter"><code>delete_account</code></em> :</span></p></td>
 158 <td>whether the user account should be deleted</td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 </div>
 163 <hr>
 164 <div class="refsect2">
 165 <a name="tlm-account-plugin-is-valid-user"></a><h3>tlm_account_plugin_is_valid_user ()</h3>
 166 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tlm_account_plugin_is_valid_user    (<em class="parameter"><code><span class="type">TlmAccountPlugin</span> *self</code></em>,
 167                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *user_name</code></em>);</pre>
 168 <p>
 169 Checks if the user with a given <em class="parameter"><code>user_name</code></em> exists.
 170 </p>
 171 <div class="variablelist"><table border="0">
 172 <col align="left" valign="top">
 173 <tbody>
 174 <tr>
 175 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 176 <td>plugin instance</td>
 177 </tr>
 178 <tr>
 179 <td><p><span class="term"><em class="parameter"><code>user_name</code></em> :</span></p></td>
 180 <td>user name to check</td>
 181 </tr>
 182 </tbody>
 183 </table></div>
 184 </div>
 185 <hr>
 186 <div class="refsect2">
 187 <a name="tlm-account-plugin-setup-guest-user-account"></a><h3>tlm_account_plugin_setup_guest_user_account ()</h3>
 188 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tlm_account_plugin_setup_guest_user_account
 189                                                         (<em class="parameter"><code><span class="type">TlmAccountPlugin</span> *self</code></em>,
 190                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *user_name</code></em>);</pre>
 191 <p>
 192 This method creates and sets up a guest user account with a provided
 193 <em class="parameter"><code>user_name</code></em>.
 194 </p>
 195 <div class="variablelist"><table border="0">
 196 <col align="left" valign="top">
 197 <tbody>
 198 <tr>
 199 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 200 <td>plugin instance</td>
 201 </tr>
 202 <tr>
 203 <td><p><span class="term"><em class="parameter"><code>user_name</code></em> :</span></p></td>
 204 <td>the user name</td>
 205 </tr>
 206 <tr>
 207 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 208 <td>whether the operation succeeded.</td>
 209 </tr>
 210 </tbody>
 211 </table></div>
 212 </div>
 213 </div>
 214 </div>
 215 <div class="footer">
 216 <hr>
 217           Generated by GTK-Doc V1.18</div>
 218 </body>
 219 </html>