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" [
5 <refentry id="gdbus-org.tizen.Tlm.Login">
6 <refmeta> <refentrytitle role="top_of_page" id="gdbus-interface-org-tizen-Tlm-Login.top_of_page">org.tizen.Tlm.Login</refentrytitle>
7 <indexterm zone="gdbus-interface-org-tizen-Tlm-Login.top_of_page"><primary sortas="Login">org.tizen.Tlm.Login</primary></indexterm>
8 </refmeta> <refnamediv> <refname>org.tizen.Tlm.Login</refname> <refpurpose>a D-Bus interface to TLM</refpurpose> </refnamediv> <refsynopsisdiv role="synopsis">
9 <title role="synopsis.title">Methods</title>
11 <link linkend="gdbus-method-org-tizen-Tlm-Login.loginUser">loginUser</link> (IN s seat_id,
15 <link linkend="gdbus-method-org-tizen-Tlm-Login.logoutUser">logoutUser</link> (IN s seat_id);
16 <link linkend="gdbus-method-org-tizen-Tlm-Login.switchUser">switchUser</link> (IN s seat_id,
22 <refsect1 role="desc" id="gdbus-interface-org-tizen-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/<seat_id-uid> by the user (uid) who is logged in
32 at the seat (seat_id).
35 <refsect1 role="details" id="gdbus-methods-org.tizen.Tlm.Login">
36 <title role="details.title">Method Details</title>
37 <refsect2 role="method" id="gdbus-method-org-tizen-Tlm-Login.loginUser">
38 <title>The loginUser() method</title>
39 <indexterm zone="gdbus-method-org-tizen-Tlm-Login.loginUser"><primary sortas="Login.loginUser">org.tizen.Tlm.Login.loginUser()</primary></indexterm>
41 loginUser (IN s seat_id,
46 <para> Login the user. loginUser() will fail if the user is already logged in,
47 while switchUser() will not.
49 <variablelist role="params">
51 <term><literal>IN s <parameter>seat_id</parameter></literal>:</term>
52 <listitem><para>id of the seat</para></listitem>
55 <term><literal>IN s <parameter>username</parameter></literal>:</term>
56 <listitem><para>name of the user</para></listitem>
59 <term><literal>IN s <parameter>password</parameter></literal>:</term>
60 <listitem><para>password to use for login</para></listitem>
63 <term><literal>IN a{ss} <parameter>environ</parameter></literal>:</term>
64 <listitem><para>key-value pairs of environment variables</para></listitem>
68 <refsect2 role="method" id="gdbus-method-org-tizen-Tlm-Login.logoutUser">
69 <title>The logoutUser() method</title>
70 <indexterm zone="gdbus-method-org-tizen-Tlm-Login.logoutUser"><primary sortas="Login.logoutUser">org.tizen.Tlm.Login.logoutUser()</primary></indexterm>
72 logoutUser (IN s seat_id);
74 <para> Logout the user.
76 <variablelist role="params">
78 <term><literal>IN s <parameter>seat_id</parameter></literal>:</term>
79 <listitem><para>id of the seat</para></listitem>
83 <refsect2 role="method" id="gdbus-method-org-tizen-Tlm-Login.switchUser">
84 <title>The switchUser() method</title>
85 <indexterm zone="gdbus-method-org-tizen-Tlm-Login.switchUser"><primary sortas="Login.switchUser">org.tizen.Tlm.Login.switchUser()</primary></indexterm>
87 switchUser (IN s seat_id,
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.
96 <variablelist role="params">
98 <term><literal>IN s <parameter>seat_id</parameter></literal>:</term>
99 <listitem><para>id of the seat</para></listitem>
102 <term><literal>IN s <parameter>username</parameter></literal>:</term>
103 <listitem><para>name of the user</para></listitem>
106 <term><literal>IN s <parameter>password</parameter></literal>:</term>
107 <listitem><para>password to use for login</para></listitem>
110 <term><literal>IN a{ss} <parameter>environ</parameter></literal>:</term>
111 <listitem><para>key-value pairs of environment variables</para></listitem>