src/common/dbus/tlm-dbus-login-doc-gen-org.O1.Tlm.Login.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 ]>
   5 <refentry id="gdbus-org.O1.Tlm.Login">
   6   <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-O1-Tlm-Login.top_of_page">org.O1.Tlm.Login</refentrytitle>
   7   <indexterm zone="gdbus-interface-org-O1-Tlm-Login.top_of_page"><primary sortas="Login">org.O1.Tlm.Login</primary></indexterm>
   8   </refmeta>  <refnamediv>    <refname>org.O1.Tlm.Login</refname>    <refpurpose>a D-Bus interface to TLM</refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
   9     <title role="synopsis.title">Methods</title>
  10     <synopsis>
  11 <link linkend="gdbus-method-org-O1-Tlm-Login.loginUser">loginUser</link>  (IN  s     seat_id,
  12             IN  s     username,
  13             IN  s     password,
  14             IN  a{ss} environ);
  15 <link linkend="gdbus-method-org-O1-Tlm-Login.logoutUser">logoutUser</link> (IN  s     seat_id);
  16 <link linkend="gdbus-method-org-O1-Tlm-Login.switchUser">switchUser</link> (IN  s     seat_id,
  17             IN  s     username,
  18             IN  s     password,
  19             IN  a{ss} environ);
  20 </synopsis>
  21   </refsynopsisdiv>
  22 <refsect1 role="desc" id="gdbus-interface-org-O1-Tlm-Login">
  23   <title role="desc.title">Description</title>
  24   <para>    Login objects can be used to login, logout and switch users. Login object
  25     with root access is exported at TLM_DBUS_ROOT_SOCKET_ADDRESS which can be
  26     used to login, logout and switch any user. TLM_DBUS_ROOT_SOCKET_ADDRESS can
  27     be fetched as a variable from package configuration file tlm.pc.
  28     Besides whenever a user is logged in, a dbus login object is also exported
  29     which can be used for 'logout-user' and 'switch-user' functionalities by
  30     that user. The dbus object can be accessed at
  31     TLM_DBUS_SOCKET_PATH/&lt;seat_id-uid&gt; by the user (uid) who is logged in
  32     at the seat (seat_id).
  33 </para>
  34 </refsect1>
  35 <refsect1 role="details" id="gdbus-methods-org.O1.Tlm.Login">
  36   <title role="details.title">Method Details</title>
  37 <refsect2 role="method" id="gdbus-method-org-O1-Tlm-Login.loginUser">
  38   <title>The loginUser() method</title>
  39   <indexterm zone="gdbus-method-org-O1-Tlm-Login.loginUser"><primary sortas="Login.loginUser">org.O1.Tlm.Login.loginUser()</primary></indexterm>
  40 <programlisting>
  41 loginUser (IN  s     seat_id,
  42            IN  s     username,
  43            IN  s     password,
  44            IN  a{ss} environ);
  45 </programlisting>
  46 <para>        Login the user. loginUser() will fail if the user is already logged in,
  47         while switchUser() will not.
  48 </para>
  49 <variablelist role="params">
  50 <varlistentry>
  51   <term><literal>IN s <parameter>seat_id</parameter></literal>:</term>
  52   <listitem><para>id of the seat</para></listitem>
  53 </varlistentry>
  54 <varlistentry>
  55   <term><literal>IN s <parameter>username</parameter></literal>:</term>
  56   <listitem><para>name of the user</para></listitem>
  57 </varlistentry>
  58 <varlistentry>
  59   <term><literal>IN s <parameter>password</parameter></literal>:</term>
  60   <listitem><para>password to use for login</para></listitem>
  61 </varlistentry>
  62 <varlistentry>
  63   <term><literal>IN a{ss} <parameter>environ</parameter></literal>:</term>
  64   <listitem><para>key-value pairs of environment variables</para></listitem>
  65 </varlistentry>
  66 </variablelist>
  67 </refsect2>
  68 <refsect2 role="method" id="gdbus-method-org-O1-Tlm-Login.logoutUser">
  69   <title>The logoutUser() method</title>
  70   <indexterm zone="gdbus-method-org-O1-Tlm-Login.logoutUser"><primary sortas="Login.logoutUser">org.O1.Tlm.Login.logoutUser()</primary></indexterm>
  71 <programlisting>
  72 logoutUser (IN  s seat_id);
  73 </programlisting>
  74 <para>        Logout the user.
  75 </para>
  76 <variablelist role="params">
  77 <varlistentry>
  78   <term><literal>IN s <parameter>seat_id</parameter></literal>:</term>
  79   <listitem><para>id of the seat</para></listitem>
  80 </varlistentry>
  81 </variablelist>
  82 </refsect2>
  83 <refsect2 role="method" id="gdbus-method-org-O1-Tlm-Login.switchUser">
  84   <title>The switchUser() method</title>
  85   <indexterm zone="gdbus-method-org-O1-Tlm-Login.switchUser"><primary sortas="Login.switchUser">org.O1.Tlm.Login.switchUser()</primary></indexterm>
  86 <programlisting>
  87 switchUser (IN  s     seat_id,
  88             IN  s     username,
  89             IN  s     password,
  90             IN  a{ss} environ);
  91 </programlisting>
  92 <para>        Logout the currently logged in user (if any), and login new user.
  93         loginUser() will fail if the user is already logged in,
  94         while switchUser() will not.
  95 </para>
  96 <variablelist role="params">
  97 <varlistentry>
  98   <term><literal>IN s <parameter>seat_id</parameter></literal>:</term>
  99   <listitem><para>id of the seat</para></listitem>
 100 </varlistentry>
 101 <varlistentry>
 102   <term><literal>IN s <parameter>username</parameter></literal>:</term>
 103   <listitem><para>name of the user</para></listitem>
 104 </varlistentry>
 105 <varlistentry>
 106   <term><literal>IN s <parameter>password</parameter></literal>:</term>
 107   <listitem><para>password to use for login</para></listitem>
 108 </varlistentry>
 109 <varlistentry>
 110   <term><literal>IN a{ss} <parameter>environ</parameter></literal>:</term>
 111   <listitem><para>key-value pairs of environment variables</para></listitem>
 112 </varlistentry>
 113 </variablelist>
 114 </refsect2>
 115 </refsect1>
 116 </refentry>
 117