docs/tlm-dbus-session-doc-gen-org.O1.Tlm.Session.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.Session">
   6   <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-O1-Tlm-Session.top_of_page">org.O1.Tlm.Session</refentrytitle>
   7   <indexterm zone="gdbus-interface-org-O1-Tlm-Session.top_of_page"><primary sortas="Session">org.O1.Tlm.Session</primary></indexterm>
   8   </refmeta>  <refnamediv>    <refname>org.O1.Tlm.Session</refname>    <refpurpose></refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
   9     <title role="synopsis.title">Methods</title>
  10     <synopsis>
  11 <link linkend="gdbus-method-org-O1-Tlm-Session.sessionCreate">sessionCreate</link>    (IN  s     password,
  12                   IN  a{ss} environment);
  13 <link linkend="gdbus-method-org-O1-Tlm-Session.sessionTerminate">sessionTerminate</link> ();
  14 </synopsis>
  15   </refsynopsisdiv>
  16   <refsect1 role="signal_proto">
  17     <title role="signal_proto.title">Signals</title>
  18     <synopsis>
  19 <link linkend="gdbus-signal-org-O1-Tlm-Session.sessionCreated">sessionCreated</link>    (s     sessionid);
  20 <link linkend="gdbus-signal-org-O1-Tlm-Session.sessionTerminated">sessionTerminated</link> ();
  21 <link linkend="gdbus-signal-org-O1-Tlm-Session.error">error</link>             ((uis) error);
  22 <link linkend="gdbus-signal-org-O1-Tlm-Session.authenticated">authenticated</link>     ();
  23 </synopsis>
  24   </refsect1>
  25   <refsect1 role="properties">
  26     <title role="properties.title">Properties</title>
  27     <synopsis>
  28 <link linkend="gdbus-property-org-O1-Tlm-Session.seatid">seatid</link>     readwrite  s
  29 <link linkend="gdbus-property-org-O1-Tlm-Session.username">username</link>   readwrite  s
  30 <link linkend="gdbus-property-org-O1-Tlm-Session.service">service</link>    readwrite  s
  31 <link linkend="gdbus-property-org-O1-Tlm-Session.sessionid">sessionid</link>  readable   s
  32 </synopsis>
  33   </refsect1>
  34 <refsect1 role="desc" id="gdbus-interface-org-O1-Tlm-Session">
  35   <title role="desc.title">Description</title>
  36   <para></para>
  37 </refsect1>
  38 <refsect1 role="details" id="gdbus-methods-org.O1.Tlm.Session">
  39   <title role="details.title">Method Details</title>
  40 <refsect2 role="method" id="gdbus-method-org-O1-Tlm-Session.sessionCreate">
  41   <title>The sessionCreate() method</title>
  42   <indexterm zone="gdbus-method-org-O1-Tlm-Session.sessionCreate"><primary sortas="Session.sessionCreate">org.O1.Tlm.Session.sessionCreate()</primary></indexterm>
  43 <programlisting>
  44 sessionCreate (IN  s     password,
  45                IN  a{ss} environment);
  46 </programlisting>
  47 <para></para>
  48 <variablelist role="params">
  49 <varlistentry>
  50   <term><literal>IN s <parameter>password</parameter></literal>:</term>
  51   <listitem><para></para></listitem>
  52 </varlistentry>
  53 <varlistentry>
  54   <term><literal>IN a{ss} <parameter>environment</parameter></literal>:</term>
  55   <listitem><para></para></listitem>
  56 </varlistentry>
  57 </variablelist>
  58 </refsect2>
  59 <refsect2 role="method" id="gdbus-method-org-O1-Tlm-Session.sessionTerminate">
  60   <title>The sessionTerminate() method</title>
  61   <indexterm zone="gdbus-method-org-O1-Tlm-Session.sessionTerminate"><primary sortas="Session.sessionTerminate">org.O1.Tlm.Session.sessionTerminate()</primary></indexterm>
  62 <programlisting>
  63 sessionTerminate ();
  64 </programlisting>
  65 <para></para>
  66 </refsect2>
  67 </refsect1>
  68 <refsect1 role="details" id="gdbus-signals-org.O1.Tlm.Session">
  69   <title role="details.title">Signal Details</title>
  70 <refsect2 role="signal" id="gdbus-signal-org-O1-Tlm-Session.sessionCreated">
  71   <title>The "sessionCreated" signal</title>
  72   <indexterm zone="gdbus-signal-org-O1-Tlm-Session.sessionCreated"><primary sortas="Session::sessionCreated">org.O1.Tlm.Session::sessionCreated</primary></indexterm>
  73 <programlisting>
  74 sessionCreated (s sessionid);
  75 </programlisting>
  76 <para></para>
  77 <variablelist role="params">
  78 <varlistentry>
  79   <term><literal>s <parameter>sessionid</parameter></literal>:</term>
  80   <listitem><para></para></listitem>
  81 </varlistentry>
  82 </variablelist>
  83 </refsect2>
  84 <refsect2 role="signal" id="gdbus-signal-org-O1-Tlm-Session.sessionTerminated">
  85   <title>The "sessionTerminated" signal</title>
  86   <indexterm zone="gdbus-signal-org-O1-Tlm-Session.sessionTerminated"><primary sortas="Session::sessionTerminated">org.O1.Tlm.Session::sessionTerminated</primary></indexterm>
  87 <programlisting>
  88 sessionTerminated ();
  89 </programlisting>
  90 <para></para>
  91 </refsect2>
  92 <refsect2 role="signal" id="gdbus-signal-org-O1-Tlm-Session.error">
  93   <title>The "error" signal</title>
  94   <indexterm zone="gdbus-signal-org-O1-Tlm-Session.error"><primary sortas="Session::error">org.O1.Tlm.Session::error</primary></indexterm>
  95 <programlisting>
  96 error ((uis) error);
  97 </programlisting>
  98 <para></para>
  99 <variablelist role="params">
 100 <varlistentry>
 101   <term><literal>(uis) <parameter>error</parameter></literal>:</term>
 102   <listitem><para></para></listitem>
 103 </varlistentry>
 104 </variablelist>
 105 </refsect2>
 106 <refsect2 role="signal" id="gdbus-signal-org-O1-Tlm-Session.authenticated">
 107   <title>The "authenticated" signal</title>
 108   <indexterm zone="gdbus-signal-org-O1-Tlm-Session.authenticated"><primary sortas="Session::authenticated">org.O1.Tlm.Session::authenticated</primary></indexterm>
 109 <programlisting>
 110 authenticated ();
 111 </programlisting>
 112 <para></para>
 113 </refsect2>
 114 </refsect1>
 115 <refsect1 role="details" id="gdbus-properties-org.O1.Tlm.Session">
 116   <title role="details.title">Property Details</title>
 117 <refsect2 role="property" id="gdbus-property-org-O1-Tlm-Session.seatid">
 118   <title>The "seatid" property</title>
 119   <indexterm zone="gdbus-property-org-O1-Tlm-Session.seatid"><primary sortas="Session:seatid">org.O1.Tlm.Session:seatid</primary></indexterm>
 120 <programlisting>
 121 seatid  readwrite  s
 122 </programlisting>
 123 <para></para>
 124 </refsect2>
 125 <refsect2 role="property" id="gdbus-property-org-O1-Tlm-Session.username">
 126   <title>The "username" property</title>
 127   <indexterm zone="gdbus-property-org-O1-Tlm-Session.username"><primary sortas="Session:username">org.O1.Tlm.Session:username</primary></indexterm>
 128 <programlisting>
 129 username  readwrite  s
 130 </programlisting>
 131 <para></para>
 132 </refsect2>
 133 <refsect2 role="property" id="gdbus-property-org-O1-Tlm-Session.service">
 134   <title>The "service" property</title>
 135   <indexterm zone="gdbus-property-org-O1-Tlm-Session.service"><primary sortas="Session:service">org.O1.Tlm.Session:service</primary></indexterm>
 136 <programlisting>
 137 service  readwrite  s
 138 </programlisting>
 139 <para></para>
 140 </refsect2>
 141 <refsect2 role="property" id="gdbus-property-org-O1-Tlm-Session.sessionid">
 142   <title>The "sessionid" property</title>
 143   <indexterm zone="gdbus-property-org-O1-Tlm-Session.sessionid"><primary sortas="Session:sessionid">org.O1.Tlm.Session:sessionid</primary></indexterm>
 144 <programlisting>
 145 sessionid  readable   s
 146 </programlisting>
 147 <para></para>
 148 </refsect2>
 149 </refsect1>
 150 </refentry>
 151