Current File : //proc/985914/root/data/old/usr/local/share/doc/hubic/dbusapi/dbusapi.docbook-com.hubic.general.xml
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="gdbus-com.hubic.general">
<refmeta> <refentrytitle role="top_of_page" id="gdbus-interface-com-hubic-general.top_of_page">com.hubic.general</refentrytitle>
<indexterm zone="gdbus-interface-com-hubic-general.top_of_page"><primary sortas="com.hubic.general">com.hubic.general</primary></indexterm>
</refmeta> <refnamediv> <refname>com.hubic.general</refname> <refpurpose>General API, always available</refpurpose> </refnamediv> <refsynopsisdiv role="synopsis">
<title role="synopsis.title">Methods</title>
<synopsis>
<link linkend="gdbus-method-com-hubic-general.Login">Login</link> (IN s email,
IN s password,
IN s synchronizedDir);
<link linkend="gdbus-method-com-hubic-general.Reconnect">Reconnect</link> ();
<link linkend="gdbus-method-com-hubic-general.Stop">Stop</link> ();
</synopsis>
</refsynopsisdiv>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
<link linkend="gdbus-signal-com-hubic-general.Messages">Messages</link> (i level,
s message,
s targetPath);
<link linkend="gdbus-signal-com-hubic-general.StateChanged">StateChanged</link> (s oldState,
s newState);
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
<link linkend="gdbus-property-com-hubic-general.CurrentState">CurrentState</link> readable s
<link linkend="gdbus-property-com-hubic-general.CurrentUploadSpeed">CurrentUploadSpeed</link> readable x
<link linkend="gdbus-property-com-hubic-general.CurrentDownloadSpeed">CurrentDownloadSpeed</link> readable x
<link linkend="gdbus-property-com-hubic-general.LastMessages">LastMessages</link> readable a(xiss)
</synopsis>
</refsect1>
<refsect1 role="desc" id="gdbus-interface-com-hubic-general">
<title role="desc.title">Description</title>
<para><para> Holds methods and properties that are not directly tied to a
specific account. All methods and properties of this interface
will be available at anytime.
</para><para> This interface is exposed through the <literal>/com/hubic/General</literal> object.
</para></para>
</refsect1>
<refsect1 role="details" id="gdbus-methods-com.hubic.general">
<title role="details.title">Method Details</title>
<refsect2 role="method" id="gdbus-method-com-hubic-general.Login">
<title>The Login() method</title>
<indexterm zone="gdbus-method-com-hubic-general.Login"><primary sortas="com.hubic.general.Login">com.hubic.general.Login()</primary></indexterm>
<programlisting>
Login (IN s email,
IN s password,
IN s synchronizedDir);
</programlisting>
<para><para> Connects to an existing account and starts synchronising given
folder.
</para><para> To connect without syncing, pass an empty string to synchronizedDir.
</para><para> This method will not return until connection sequence has either
finished successfully or failed (which can last up to 10 seconds).
</para></para>
<variablelist role="params">
<varlistentry>
<term><literal>IN s <parameter>email</parameter></literal>:</term>
<listitem><para>Account email address.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>IN s <parameter>password</parameter></literal>:</term>
<listitem><para>Account password string.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>IN s <parameter>synchronizedDir</parameter></literal>:</term>
<listitem><para>Directory to synchronize (absolute path).</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-com-hubic-general.Reconnect">
<title>The Reconnect() method</title>
<indexterm zone="gdbus-method-com-hubic-general.Reconnect"><primary sortas="com.hubic.general.Reconnect">com.hubic.general.Reconnect()</primary></indexterm>
<programlisting>
Reconnect ();
</programlisting>
<para><para> If a connection has been already established, it can be resumed without
passing credentials again with this method.
</para><para> A possible use of this method is to retry connection if the automatic one
failed for some reason (network not yet up, synchronized dir not yet
mounted, ...) or if you called <link linkend="gdbus-method-com-hubic-account.Logout">Logout()</link> before.
</para></para>
<variablelist role="params">
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-com-hubic-general.Stop">
<title>The Stop() method</title>
<indexterm zone="gdbus-method-com-hubic-general.Stop"><primary sortas="com.hubic.general.Stop">com.hubic.general.Stop()</primary></indexterm>
<programlisting>
Stop ();
</programlisting>
<para><para> Stops synchronization process.
</para></para>
<variablelist role="params">
</variablelist>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-signals-com.hubic.general">
<title role="details.title">Signal Details</title>
<refsect2 role="signal" id="gdbus-signal-com-hubic-general.Messages">
<title>The "Messages" signal</title>
<indexterm zone="gdbus-signal-com-hubic-general.Messages"><primary sortas="com.hubic.general::Messages">com.hubic.general::Messages</primary></indexterm>
<programlisting>
Messages (i level,
s message,
s targetPath);
</programlisting>
<para><para> Messages emitted during synchronization to under exceptional
circumstances.
</para><para> Message levels are:
<simplelist>
<member><constant>0</constant>: Information</member>
<member><constant>1</constant>: Warning</member>
<member><constant>2</constant>: Error</member>
<member><constant>3</constant>: Critical</member>
</simplelist>
</para></para>
<variablelist role="params">
<varlistentry>
<term><literal>i <parameter>level</parameter></literal>:</term>
<listitem><para>Importance level. The higher it is, the more critical is the message.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>s <parameter>message</parameter></literal>:</term>
<listitem><para>Message body. It is ready to be displayed to user and localized whenever possible.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>s <parameter>targetPath</parameter></literal>:</term>
<listitem><para>Message target path. If message is about a particular file (for instance when a conflict occur), the path to the file will be provided. Otherwise this is an empty string.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="signal" id="gdbus-signal-com-hubic-general.StateChanged">
<title>The "StateChanged" signal</title>
<indexterm zone="gdbus-signal-com-hubic-general.StateChanged"><primary sortas="com.hubic.general::StateChanged">com.hubic.general::StateChanged</primary></indexterm>
<programlisting>
StateChanged (s oldState,
s newState);
</programlisting>
<para><para> Fired when swtiching from one state to anther. See
<link linkend="gdbus-property-com-hubic-general.CurrentState">"CurrentState"</link> for a list of possible states.
</para></para>
<variablelist role="params">
<varlistentry>
<term><literal>s <parameter>oldState</parameter></literal>:</term>
<listitem><para>The state before change.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>s <parameter>newState</parameter></literal>:</term>
<listitem><para>The new state after the event.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-properties-com.hubic.general">
<title role="details.title">Property Details</title>
<refsect2 role="property" id="gdbus-property-com-hubic-general.CurrentState">
<title>The "CurrentState" property</title>
<indexterm zone="gdbus-property-com-hubic-general.CurrentState"><primary sortas="com.hubic.general:CurrentState">com.hubic.general:CurrentState</primary></indexterm>
<programlisting>
CurrentState readable s
</programlisting>
<para><para> The current state of the client. Possible states are:
<simplelist>
<member><constant>NotConnected</constant>: Client is not connected to an account</member>
<member><constant>Connecting</constant>: Connection is in progress</member>
<member><constant>Paused</constant>: Client is in pause, no synchronization will occur</member>
<member><constant>Idle</constant>: Connected, watching for changes and wait for next sync</member>
<member><constant>Busy</constant>: Connected and currently index/synchronize content</member>
</simplelist>
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-general.CurrentUploadSpeed">
<title>The "CurrentUploadSpeed" property</title>
<indexterm zone="gdbus-property-com-hubic-general.CurrentUploadSpeed"><primary sortas="com.hubic.general:CurrentUploadSpeed">com.hubic.general:CurrentUploadSpeed</primary></indexterm>
<programlisting>
CurrentUploadSpeed readable x
</programlisting>
<para><para> The current upload speed. It includes any <emphasis>utility</emphasis>
requests that can be done by client such as listings, ...
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-general.CurrentDownloadSpeed">
<title>The "CurrentDownloadSpeed" property</title>
<indexterm zone="gdbus-property-com-hubic-general.CurrentDownloadSpeed"><primary sortas="com.hubic.general:CurrentDownloadSpeed">com.hubic.general:CurrentDownloadSpeed</primary></indexterm>
<programlisting>
CurrentDownloadSpeed readable x
</programlisting>
<para><para> The current download speed. It includes any <emphasis>utility</emphasis>
requests that can be done by client such as listings, ...
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-general.LastMessages">
<title>The "LastMessages" property</title>
<indexterm zone="gdbus-property-com-hubic-general.LastMessages"><primary sortas="com.hubic.general:LastMessages">com.hubic.general:LastMessages</primary></indexterm>
<programlisting>
LastMessages readable a(xiss)
</programlisting>
<para><para> History of 10 last <link linkend="gdbus-signal-com-hubic-general.Messages">"Messages"</link> signals preceeded by a
Unix timestamp.
</para></para>
</refsect2>
</refsect1>
</refentry>
Mini Shell