Current File : //proc/985914/root/data/old/usr/local/share/doc/hubic/dbusapi/index.html
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>hubiC DBus API Documenation</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="reference" title="hubiC DBus API Documenation"><div class="titlepage"><div><div><h1 class="title"><a name="idp56720"></a>hubiC DBus API Documenation</h1></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="refentrytitle"><a href="#idp3809040"></a></span><span class="refpurpose"></span></dt><dt><span class="refentrytitle"><a href="#gdbus-com.hubic.general">com.hubic.general</a></span><span class="refpurpose"> — General API, always available</span></dt><dt><span class="refentrytitle"><a href="#gdbus-com.hubic.account">com.hubic.account</a></span><span class="refpurpose"> — Account dependant API.</span></dt><dt><span class="refentrytitle"><a href="#gdbus-com.hubic.settings">com.hubic.settings</a></span><span class="refpurpose"></span></dt><dt><span class="refentrytitle"><a href="#gdbus-com.hubic.backup">com.hubic.backup</a></span><span class="refpurpose"> — Controls backup state and settings.</span></dt></dl></div><div class="refentry" title="REFENTRY WITHOUT TITLE???"><a name="idp3809040"></a><div class="titlepage"></div><div class="refsect1" title="Introduction"><a name="idp3809296"></a><h2>Introduction</h2><p>
As the hubiC client is just a headless service, it exposes an API to
communicate with third party software. This API can be consumed with
the widely used D-Bus IPC machanism.
</p><p>
The API is exposed on a session bus with <code class="literal">com.hubiC</code>
unique bus name. It is splitted over multiple objects.
</p><p>
The background synchronization process is registered as a D-Bus service
so it should be started transparently when calling the API if it's not
already running.
</p></div></div><div class="refentry" title="com.hubic.general"><div class="refentry.separator"><hr></div><a name="gdbus-com.hubic.general"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>com.hubic.general — General API, always available</p></div><div class="refsynopsisdiv" title="Methods"><h2>Methods</h2><pre class="synopsis">
<a class="link" href="#gdbus-method-com-hubic-general.Login" title="The Login() method">Login</a> (IN s email,
IN s password,
IN s synchronizedDir);
<a class="link" href="#gdbus-method-com-hubic-general.Reconnect" title="The Reconnect() method">Reconnect</a> ();
<a class="link" href="#gdbus-method-com-hubic-general.Stop" title="The Stop() method">Stop</a> ();
</pre></div><div class="refsect1" title="Signals"><a name="idp7723440"></a><h2>Signals</h2><pre class="synopsis">
<a class="link" href="#gdbus-signal-com-hubic-general.Messages" title='The "Messages" signal'>Messages</a> (i level,
s message,
s targetPath);
<a class="link" href="#gdbus-signal-com-hubic-general.StateChanged" title='The "StateChanged" signal'>StateChanged</a> (s oldState,
s newState);
</pre></div><div class="refsect1" title="Properties"><a name="idp7737520"></a><h2>Properties</h2><pre class="synopsis">
<a class="link" href="#gdbus-property-com-hubic-general.CurrentState" title='The "CurrentState" property'>CurrentState</a> readable s
<a class="link" href="#gdbus-property-com-hubic-general.CurrentUploadSpeed" title='The "CurrentUploadSpeed" property'>CurrentUploadSpeed</a> readable x
<a class="link" href="#gdbus-property-com-hubic-general.CurrentDownloadSpeed" title='The "CurrentDownloadSpeed" property'>CurrentDownloadSpeed</a> readable x
<a class="link" href="#gdbus-property-com-hubic-general.LastMessages" title='The "LastMessages" property'>LastMessages</a> readable a(xiss)
</pre></div><div class="refsect1" title="Description"><a name="gdbus-interface-com-hubic-general"></a><h2>Description</h2><p> 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.
</p><p> This interface is exposed through the <code class="literal">/com/hubic/General</code> object.
</p></div><div class="refsect1" title="Method Details"><a name="gdbus-methods-com.hubic.general"></a><h2>Method Details</h2><div class="refsect2" title="The Login() method"><a name="gdbus-method-com-hubic-general.Login"></a><h3>The Login() method</h3><a class="indexterm" name="idp4891840"></a><pre class="programlisting">
Login (IN s email,
IN s password,
IN s synchronizedDir);
</pre><p> Connects to an existing account and starts synchronising given
folder.
</p><p> To connect without syncing, pass an empty string to synchronizedDir.
</p><p> This method will not return until connection sequence has either
finished successfully or failed (which can last up to 10 seconds).
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>email</code></em></code>:</span></dt><dd><p>Account email address.</p></dd><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>password</code></em></code>:</span></dt><dd><p>Account password string.</p></dd><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>synchronizedDir</code></em></code>:</span></dt><dd><p>Directory to synchronize (absolute path).</p></dd></dl></div></div><div class="refsect2" title="The Reconnect() method"><a name="gdbus-method-com-hubic-general.Reconnect"></a><h3>The Reconnect() method</h3><a class="indexterm" name="idp25280"></a><pre class="programlisting">
Reconnect ();
</pre><p> If a connection has been already established, it can be resumed without
passing credentials again with this method.
</p><p> 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 <a class="link" href="#gdbus-method-com-hubic-account.Logout" title="The Logout() method">Logout()</a> before.
</p><div class="variablelist"><dl></dl></div></div><div class="refsect2" title="The Stop() method"><a name="gdbus-method-com-hubic-general.Stop"></a><h3>The Stop() method</h3><a class="indexterm" name="idp31552"></a><pre class="programlisting">
Stop ();
</pre><p> Stops synchronization process.
</p><div class="variablelist"><dl></dl></div></div></div><div class="refsect1" title="Signal Details"><a name="gdbus-signals-com.hubic.general"></a><h2>Signal Details</h2><div class="refsect2" title='The "Messages" signal'><a name="gdbus-signal-com-hubic-general.Messages"></a><h3>The "Messages" signal</h3><a class="indexterm" name="idp38288"></a><pre class="programlisting">
Messages (i level,
s message,
s targetPath);
</pre><p> Messages emitted during synchronization to under exceptional
circumstances.
</p><p> Message levels are:
</p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="constant">0</code>: Information</td></tr><tr><td><code class="constant">1</code>: Warning</td></tr><tr><td><code class="constant">2</code>: Error</td></tr><tr><td><code class="constant">3</code>: Critical</td></tr></table><p>
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">i <em class="parameter"><code>level</code></em></code>:</span></dt><dd><p>Importance level. The higher it is, the more critical is the message.</p></dd><dt><span class="term"><code class="literal">s <em class="parameter"><code>message</code></em></code>:</span></dt><dd><p>Message body. It is ready to be displayed to user and localized whenever possible.</p></dd><dt><span class="term"><code class="literal">s <em class="parameter"><code>targetPath</code></em></code>:</span></dt><dd><p>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.</p></dd></dl></div></div><div class="refsect2" title='The "StateChanged" signal'><a name="gdbus-signal-com-hubic-general.StateChanged"></a><h3>The "StateChanged" signal</h3><a class="indexterm" name="idp7086944"></a><pre class="programlisting">
StateChanged (s oldState,
s newState);
</pre><p> Fired when swtiching from one state to anther. See
<a class="link" href="#gdbus-property-com-hubic-general.CurrentState" title='The "CurrentState" property'>"CurrentState"</a> for a list of possible states.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">s <em class="parameter"><code>oldState</code></em></code>:</span></dt><dd><p>The state before change.</p></dd><dt><span class="term"><code class="literal">s <em class="parameter"><code>newState</code></em></code>:</span></dt><dd><p>The new state after the event.</p></dd></dl></div></div></div><div class="refsect1" title="Property Details"><a name="gdbus-properties-com.hubic.general"></a><h2>Property Details</h2><div class="refsect2" title='The "CurrentState" property'><a name="gdbus-property-com-hubic-general.CurrentState"></a><h3>The "CurrentState" property</h3><a class="indexterm" name="idp7099408"></a><pre class="programlisting">
CurrentState readable s
</pre><p> The current state of the client. Possible states are:
</p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="constant">NotConnected</code>: Client is not connected to an account</td></tr><tr><td><code class="constant">Connecting</code>: Connection is in progress</td></tr><tr><td><code class="constant">Paused</code>: Client is in pause, no synchronization will occur</td></tr><tr><td><code class="constant">Idle</code>: Connected, watching for changes and wait for next sync</td></tr><tr><td><code class="constant">Busy</code>: Connected and currently index/synchronize content</td></tr></table><p>
</p></div><div class="refsect2" title='The "CurrentUploadSpeed" property'><a name="gdbus-property-com-hubic-general.CurrentUploadSpeed"></a><h3>The "CurrentUploadSpeed" property</h3><a class="indexterm" name="idp7107840"></a><pre class="programlisting">
CurrentUploadSpeed readable x
</pre><p> The current upload speed. It includes any <span class="emphasis"><em>utility</em></span>
requests that can be done by client such as listings, ...
</p></div><div class="refsect2" title='The "CurrentDownloadSpeed" property'><a name="gdbus-property-com-hubic-general.CurrentDownloadSpeed"></a><h3>The "CurrentDownloadSpeed" property</h3><a class="indexterm" name="idp7112352"></a><pre class="programlisting">
CurrentDownloadSpeed readable x
</pre><p> The current download speed. It includes any <span class="emphasis"><em>utility</em></span>
requests that can be done by client such as listings, ...
</p></div><div class="refsect2" title='The "LastMessages" property'><a name="gdbus-property-com-hubic-general.LastMessages"></a><h3>The "LastMessages" property</h3><a class="indexterm" name="idp7116864"></a><pre class="programlisting">
LastMessages readable a(xiss)
</pre><p> History of 10 last <a class="link" href="#gdbus-signal-com-hubic-general.Messages" title='The "Messages" signal'>"Messages"</a> signals preceeded by a
Unix timestamp.
</p></div></div></div><div class="refentry" title="com.hubic.account"><div class="refentry.separator"><hr></div><a name="gdbus-com.hubic.account"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>com.hubic.account — Account dependant API.</p></div><div class="refsynopsisdiv" title="Methods"><h2>Methods</h2><pre class="synopsis">
<a class="link" href="#gdbus-method-com-hubic-account.Logout" title="The Logout() method">Logout</a> ();
<a class="link" href="#gdbus-method-com-hubic-account.SynchronizeNow" title="The SynchronizeNow() method">SynchronizeNow</a> ();
<a class="link" href="#gdbus-method-com-hubic-account.SetPauseState" title="The SetPauseState() method">SetPauseState</a> (IN b paused);
<a class="link" href="#gdbus-method-com-hubic-account.Publish" title="The Publish() method">Publish</a> (IN s absolutePath);
<a class="link" href="#gdbus-method-com-hubic-account.PublishWithDuration" title="The PublishWithDuration() method">PublishWithDuration</a> (IN s absolutePath,
IN i duration);
<a class="link" href="#gdbus-method-com-hubic-account.Unpublish" title="The Unpublish() method">Unpublish</a> (IN s absolutePath);
<a class="link" href="#gdbus-method-com-hubic-account.GetPublishUrl" title="The GetPublishUrl() method">GetPublishUrl</a> (IN s absolutePath,
OUT s ret);
<a class="link" href="#gdbus-method-com-hubic-account.GetItemStatus" title="The GetItemStatus() method">GetItemStatus</a> (IN s absolutePath,
OUT (sbb) ret);
<a class="link" href="#gdbus-method-com-hubic-account.CreateBackup" title="The CreateBackup() method">CreateBackup</a> (IN s path,
IN s name,
IN s frequency,
IN i versionsKept,
IN b keepDeletedFiles);
</pre></div><div class="refsect1" title="Signals"><a name="idp9277424"></a><h2>Signals</h2><pre class="synopsis">
<a class="link" href="#gdbus-signal-com-hubic-account.ItemChanged" title='The "ItemChanged" signal'>ItemChanged</a> (s absolutePath);
</pre></div><div class="refsect1" title="Properties"><a name="idp6595904"></a><h2>Properties</h2><pre class="synopsis">
<a class="link" href="#gdbus-property-com-hubic-account.QueueStatus" title='The "QueueStatus" property'>QueueStatus</a> readable (iiixx)
<a class="link" href="#gdbus-property-com-hubic-account.RunningOperations" title='The "RunningOperations" property'>RunningOperations</a> readable a(xsssxx)
<a class="link" href="#gdbus-property-com-hubic-account.PublishedFiles" title='The "PublishedFiles" property'>PublishedFiles</a> readable a(ssx)
<a class="link" href="#gdbus-property-com-hubic-account.Account" title='The "Account" property'>Account</a> readable s
<a class="link" href="#gdbus-property-com-hubic-account.SynchronizedDir" title='The "SynchronizedDir" property'>SynchronizedDir</a> readwrite s
<a class="link" href="#gdbus-property-com-hubic-account.ExcludedFolders" title='The "ExcludedFolders" property'>ExcludedFolders</a> readwrite as
<a class="link" href="#gdbus-property-com-hubic-account.TotalBytes" title='The "TotalBytes" property'>TotalBytes</a> readable x
<a class="link" href="#gdbus-property-com-hubic-account.UsedBytes" title='The "UsedBytes" property'>UsedBytes</a> readable x
</pre></div><div class="refsect1" title="Description"><a name="gdbus-interface-com-hubic-account"></a><h2>Description</h2><p> Holds methds and properties that are are linked to the current connected
account (if any).
</p><p> In <code class="constant">NotConnected</code> or <code class="constant">Connecting</code> states, methods usually raises an error if
they are called, properties returns a default value for Get opreation, Set
also results in error.
</p><p> This interface is exposed through the <code class="literal">/com/hubic/Account</code> object.
</p></div><div class="refsect1" title="Method Details"><a name="gdbus-methods-com.hubic.account"></a><h2>Method Details</h2><div class="refsect2" title="The Logout() method"><a name="gdbus-method-com-hubic-account.Logout"></a><h3>The Logout() method</h3><a class="indexterm" name="idp257456"></a><pre class="programlisting">
Logout ();
</pre><p> Disconnect current account so you can call <a class="link" href="#gdbus-method-com-hubic-general.Login" title="The Login() method">Login()</a> or
<a class="link" href="#gdbus-method-com-hubic-general.Reconnect" title="The Reconnect() method">Reconnect()</a> again.
</p><div class="variablelist"><dl></dl></div></div><div class="refsect2" title="The SynchronizeNow() method"><a name="gdbus-method-com-hubic-account.SynchronizeNow"></a><h3>The SynchronizeNow() method</h3><a class="indexterm" name="idp263680"></a><pre class="programlisting">
SynchronizeNow ();
</pre><p> Triggers an immediate and complete synchronization cycle.
</p><div class="variablelist"><dl></dl></div></div><div class="refsect2" title="The SetPauseState() method"><a name="gdbus-method-com-hubic-account.SetPauseState"></a><h3>The SetPauseState() method</h3><a class="indexterm" name="idp6289744"></a><pre class="programlisting">
SetPauseState (IN b paused);
</pre><p> Change pause status. When enabling pause state, aborts any running operation.
When resuming synchronization, makes a complete synchronization cycle.
</p><p> See <a class="link" href="#gdbus-property-com-hubic-general.CurrentState" title='The "CurrentState" property'>"CurrentState"</a> and <a class="link" href="#gdbus-signal-com-hubic-general.StateChanged" title='The "StateChanged" signal'>"StateChanged"</a>
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN b <em class="parameter"><code>paused</code></em></code>:</span></dt><dd><p><code class="constant">true</code> to set account in <code class="constant">Paused</code> state, <code class="constant">false</code> to resume synchronization.</p></dd></dl></div></div><div class="refsect2" title="The Publish() method"><a name="gdbus-method-com-hubic-account.Publish"></a><h3>The Publish() method</h3><a class="indexterm" name="idp6300320"></a><pre class="programlisting">
Publish (IN s absolutePath);
</pre><p> Publish a new file or folder. On failure, an error is raised and a message
is sent over <a class="link" href="#gdbus-signal-com-hubic-general.Messages" title='The "Messages" signal'>"Messages"</a> explaining what went wrong.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>absolutePath</code></em></code>:</span></dt><dd><p>File to publish.</p></dd></dl></div></div><div class="refsect2" title="The PublishWithDuration() method"><a name="gdbus-method-com-hubic-account.PublishWithDuration"></a><h3>The PublishWithDuration() method</h3><a class="indexterm" name="idp7127056"></a><pre class="programlisting">
PublishWithDuration (IN s absolutePath,
IN i duration);
</pre><p> Publish a new file or folder. On failure, an error is raised and a message
is sent over <a class="link" href="#gdbus-signal-com-hubic-general.Messages" title='The "Messages" signal'>"Messages"</a> explaining what went wrong.
</p><p> In case of illegal TTL, just the error will be raised.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>absolutePath</code></em></code>:</span></dt><dd><p>File to publish.</p></dd><dt><span class="term"><code class="literal">IN i <em class="parameter"><code>duration</code></em></code>:</span></dt><dd><p>Publication time to live (in days). Currently legal values are 1, 5, 10, 15, 20, 25, 30.</p></dd></dl></div></div><div class="refsect2" title="The Unpublish() method"><a name="gdbus-method-com-hubic-account.Unpublish"></a><h3>The Unpublish() method</h3><a class="indexterm" name="idp7138192"></a><pre class="programlisting">
Unpublish (IN s absolutePath);
</pre><p> Deleted publication of a file. If the file were not published,
this is a no-op.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>absolutePath</code></em></code>:</span></dt><dd><p>File to unpublish.</p></dd></dl></div></div><div class="refsect2" title="The GetPublishUrl() method"><a name="gdbus-method-com-hubic-account.GetPublishUrl"></a><h3>The GetPublishUrl() method</h3><a class="indexterm" name="idp7145712"></a><pre class="programlisting">
GetPublishUrl (IN s absolutePath,
OUT s ret);
</pre><p> Retrieves the URL of an already published file. If path was not published
this result in an error.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>absolutePath</code></em></code>:</span></dt><dd><p>File to get the public URL.</p></dd><dt><span class="term"><code class="literal">OUT s <em class="parameter"><code>ret</code></em></code>:</span></dt><dd><p>Public URL.</p></dd></dl></div></div><div class="refsect2" title="The GetItemStatus() method"><a name="gdbus-method-com-hubic-account.GetItemStatus"></a><h3>The GetItemStatus() method</h3><a class="indexterm" name="idp7155888"></a><pre class="programlisting">
GetItemStatus (IN s absolutePath,
OUT (sbb) ret);
</pre><p> This method is intended to quickly gives the status of a particular file
or folder. It notably used to draw the overlay icons on Windows and MacOSX.
</p><p> This method does not raise error if it is called in <code class="constant">NotConnected</code> or
<code class="constant">Connecting</code> state.
</p><p> The returned tuple is (in order):
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">Status</code> (string)</span></dt><dd><p>
The synchronization status. It can be <code class="literal">Synchronized</code>
(file is ok), <code class="literal">Unsynchronized</code> (the file is either
downloading or uploading), <code class="literal">NoStatus</code> (the file is
filtered out or outside of synchronized directory) or else
<code class="literal">Error</code> when an unexpected exception happen.
</p></dd><dt><span class="term"><code class="literal">IsPublished</code> (bool)</span></dt><dd><p>
Whether the item is published or not.
</p></dd><dt><span class="term"><code class="literal">CanBePublished</code> (bool)</span></dt><dd><p>
Whether the item could be published. It this is false, trying to
<a class="link" href="#gdbus-method-com-hubic-account.Publish" title="The Publish() method">Publish()</a> the item will certainly fail.
</p></dd></dl></div><p>
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>absolutePath</code></em></code>:</span></dt><dd><p>File to get the status from.</p></dd><dt><span class="term"><code class="literal">OUT (sbb) <em class="parameter"><code>ret</code></em></code>:</span></dt><dd><p>A tuple containing the file status.</p></dd></dl></div></div><div class="refsect2" title="The CreateBackup() method"><a name="gdbus-method-com-hubic-account.CreateBackup"></a><h3>The CreateBackup() method</h3><a class="indexterm" name="idp7177952"></a><pre class="programlisting">
CreateBackup (IN s path,
IN s name,
IN s frequency,
IN i versionsKept,
IN b keepDeletedFiles);
</pre><p> This method creates a new backup, the created backup will be acessible
through /com/hubib/Backup/<name> path.
</p><p> This method may raise an error if the name or frequency are invalid,
if the path cannot be accessed, ...
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>path</code></em></code>:</span></dt><dd><p>Local folder to backup</p></dd><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></dt><dd><p>Backup name (must be a unique non empty string)</p></dd><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>frequency</code></em></code>:</span></dt><dd><p>Automatic backup frequency. Must be one of: "never", "hourly", "daily", "weekly" (case insensitive).</p></dd><dt><span class="term"><code class="literal">IN i <em class="parameter"><code>versionsKept</code></em></code>:</span></dt><dd><p>Number of versions to keep (0: no versioning, negative: infinite versioning)</p></dd><dt><span class="term"><code class="literal">IN b <em class="parameter"><code>keepDeletedFiles</code></em></code>:</span></dt><dd><p>whether or not the locally deleted files are also deleted on hubiC.</p></dd></dl></div></div></div><div class="refsect1" title="Signal Details"><a name="gdbus-signals-com.hubic.account"></a><h2>Signal Details</h2><div class="refsect2" title='The "ItemChanged" signal'><a name="gdbus-signal-com-hubic-account.ItemChanged"></a><h3>The "ItemChanged" signal</h3><a class="indexterm" name="idp7198224"></a><pre class="programlisting">
ItemChanged (s absolutePath);
</pre><p> Signal raised when a file or folder status changed somehow so
<a class="link" href="#gdbus-method-com-hubic-account.GetItemStatus" title="The GetItemStatus() method">GetItemStatus()</a> should be called again to update file (e.g. change
overlay icon, ...).
</p><p> This signal can be raised in following cases:
</p><table border="0" summary="Simple list" class="simplelist"><tr><td>The item has been modified so it need to be synced,</td></tr><tr><td>The item synchronization operation(s) has been finished,</td></tr><tr><td>The item has been (un)published.</td></tr></table><p>
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">s <em class="parameter"><code>absolutePath</code></em></code>:</span></dt><dd><p>File or folder to update.</p></dd></dl></div></div></div><div class="refsect1" title="Property Details"><a name="gdbus-properties-com.hubic.account"></a><h2>Property Details</h2><div class="refsect2" title='The "QueueStatus" property'><a name="gdbus-property-com-hubic-account.QueueStatus"></a><h3>The "QueueStatus" property</h3><a class="indexterm" name="idp7210512"></a><pre class="programlisting">
QueueStatus readable (iiixx)
</pre><p> Current status of synchronization queue. Gives how many items are
wating to be synchronized. This will be non-zero only in <code class="constant">Busy</code> state.
</p><p> The tuple is (in order):
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">QueuedUploads</code> (int)</span></dt><dd><p>Number of queued upload operations.</p></dd><dt><span class="term"><code class="literal">QueuedDownloads</code> (int)</span></dt><dd><p>Number of queued download operations.</p></dd><dt><span class="term"><code class="literal">QueuedMisc</code> (int)</span></dt><dd><p>Number of other queued operation. This include deletes, copies, renames, ...</p></dd><dt><span class="term"><code class="literal">QueuedBytesToUpload</code> (long)</span></dt><dd><p>Amount of bytes to upload. Sum of sizes of <code class="constant">QueuedUploads</code></p></dd><dt><span class="term"><code class="literal">QueuedBytesToDownload</code> (long)</span></dt><dd><p>Amount of bytes to download. Sum of sizes of <code class="constant">QueuedDownloads</code></p></dd></dl></div><p>
</p></div><div class="refsect2" title='The "RunningOperations" property'><a name="gdbus-property-com-hubic-account.RunningOperations"></a><h3>The "RunningOperations" property</h3><a class="indexterm" name="idp7226624"></a><pre class="programlisting">
RunningOperations readable a(xsssxx)
</pre><p> List of currently running operations. It will be an empty list except
during <code class="constant">Busy</code> state.
</p><p> The value is an array of tuples, themselves composed of (in order):
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">Id</code> (int)</span></dt><dd><p>Some unique operation id. Can be used to bind
some progress indicator to the operation.</p></dd><dt><span class="term"><code class="literal">SourcePath</code> (string)</span></dt><dd><p>File on which operation work.</p></dd><dt><span class="term"><code class="literal">DestinationPath</code> (string)</span></dt><dd><p>Only used for copies and renames.</p></dd><dt><span class="term"><code class="literal">OperationType</code> (string)</span></dt><dd><p>Name of operation.</p></dd><dt><span class="term"><code class="literal">BytesDone</code> (long)</span></dt><dd><p>Current progress of operation (for <code class="constant">Upload</code> and <code class="constant">Download</code>),
or else -1 if operation does not have progress.</p></dd><dt><span class="term"><code class="literal">TotalBytes</code> (long)</span></dt><dd><p>Size of file to process (for <code class="constant">Upload</code> and <code class="constant">Download</code>),
or else -1 if operation does not have progress.</p></dd></dl></div><p>
</p></div><div class="refsect2" title='The "PublishedFiles" property'><a name="gdbus-property-com-hubic-account.PublishedFiles"></a><h3>The "PublishedFiles" property</h3><a class="indexterm" name="idp7246160"></a><pre class="programlisting">
PublishedFiles readable a(ssx)
</pre><p> List of all published files. This list is cached locally and is updated
time to time so it is fast to retrieve (but may not be up to date in some
cases).
</p><p> The value is an array of tuples, themselves composed of (in order):
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">Path</code> (string)</span></dt><dd><p>File on which operation work.</p></dd><dt><span class="term"><code class="literal">Url</code> (string)</span></dt><dd><p>The public HTTP link to see publication.</p></dd><dt><span class="term"><code class="literal">PublishedUntil</code> (long)</span></dt><dd><p>Date of the end of publication (Unix timestamp).</p></dd></dl></div><p>
</p></div><div class="refsect2" title='The "Account" property'><a name="gdbus-property-com-hubic-account.Account"></a><h3>The "Account" property</h3><a class="indexterm" name="idp7257184"></a><pre class="programlisting">
Account readable s
</pre><p> Account email address. Returns an empty string when no account is connected.
</p></div><div class="refsect2" title='The "SynchronizedDir" property'><a name="gdbus-property-com-hubic-account.SynchronizedDir"></a><h3>The "SynchronizedDir" property</h3><a class="indexterm" name="idp7261264"></a><pre class="programlisting">
SynchronizedDir readwrite s
</pre><p> Currently synchronized directory. Can be changed at anytime (as long as
account is connected). If operations were in progress, they are
interrupted.
</p><p> To disable synchronization, set the property to an empty string.
</p><p> Returns an empty string when no account is connected or when
synchronization is disabled.
</p></div><div class="refsect2" title='The "ExcludedFolders" property'><a name="gdbus-property-com-hubic-account.ExcludedFolders"></a><h3>The "ExcludedFolders" property</h3><a class="indexterm" name="idp7266240"></a><pre class="programlisting">
ExcludedFolders readwrite as
</pre><p> Folders that will not be synchronized nor indexed. This is a collection of
absolute paths, all of them must be inside
<a class="link" href="#gdbus-property-com-hubic-account.SynchronizedDir" title='The "SynchronizedDir" property'>"SynchronizedDir"</a>.
</p><p> It can be changed at anytime (as long as account is connected). If
operations were in progress, they are interrupted.
</p><p> Returns an empty array when no account is connected.
</p></div><div class="refsect2" title='The "TotalBytes" property'><a name="gdbus-property-com-hubic-account.TotalBytes"></a><h3>The "TotalBytes" property</h3><a class="indexterm" name="idp7271904"></a><pre class="programlisting">
TotalBytes readable x
</pre><p> Available bytes on this account or -1 for unlimited accounts or when no
account is connected.
</p></div><div class="refsect2" title='The "UsedBytes" property'><a name="gdbus-property-com-hubic-account.UsedBytes"></a><h3>The "UsedBytes" property</h3><a class="indexterm" name="idp7276112"></a><pre class="programlisting">
UsedBytes readable x
</pre><p> Currently used bytes. May take some minutes to update after operations
have been done. Returns -1 when no account is connected.
</p></div></div></div><div class="refentry" title="com.hubic.settings"><div class="refentry.separator"><hr></div><a name="gdbus-com.hubic.settings"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>com.hubic.settings</p></div><div class="refsynopsisdiv" title="Methods"><h2>Methods</h2><pre class="synopsis">
<a class="link" href="#gdbus-method-com-hubic-settings.GetSetting" title="The GetSetting() method">GetSetting</a> (IN s setting,
OUT s ret);
<a class="link" href="#gdbus-method-com-hubic-settings.SetSetting" title="The SetSetting() method">SetSetting</a> (IN s setting,
IN s value);
<a class="link" href="#gdbus-method-com-hubic-settings.SetProxy" title="The SetProxy() method">SetProxy</a> (IN s hostname,
IN i port);
<a class="link" href="#gdbus-method-com-hubic-settings.SetAuthenticatedProxy" title="The SetAuthenticatedProxy() method">SetAuthenticatedProxy</a> (IN s hostname,
IN i port,
IN s username,
IN s password);
<a class="link" href="#gdbus-method-com-hubic-settings.UnsetProxy" title="The UnsetProxy() method">UnsetProxy</a> ();
</pre></div><div class="refsect1" title="Properties"><a name="idp8838928"></a><h2>Properties</h2><pre class="synopsis">
<a class="link" href="#gdbus-property-com-hubic-settings.TimeBetweenSynchronization" title='The "TimeBetweenSynchronization" property'>TimeBetweenSynchronization</a> readwrite u
<a class="link" href="#gdbus-property-com-hubic-settings.UseRecycleBin" title='The "UseRecycleBin" property'>UseRecycleBin</a> readwrite b
<a class="link" href="#gdbus-property-com-hubic-settings.AllowBugReporting" title='The "AllowBugReporting" property'>AllowBugReporting</a> readwrite b
<a class="link" href="#gdbus-property-com-hubic-settings.UploadSpeedLimit" title='The "UploadSpeedLimit" property'>UploadSpeedLimit</a> readwrite x
<a class="link" href="#gdbus-property-com-hubic-settings.DownloadSpeedLimit" title='The "DownloadSpeedLimit" property'>DownloadSpeedLimit</a> readwrite x
<a class="link" href="#gdbus-property-com-hubic-settings.ProxyEnabled" title='The "ProxyEnabled" property'>ProxyEnabled</a> readable b
<a class="link" href="#gdbus-property-com-hubic-settings.ProxyHost" title='The "ProxyHost" property'>ProxyHost</a> readable s
<a class="link" href="#gdbus-property-com-hubic-settings.ProxyPort" title='The "ProxyPort" property'>ProxyPort</a> readable i
<a class="link" href="#gdbus-property-com-hubic-settings.ProxyUsername" title='The "ProxyUsername" property'>ProxyUsername</a> readable s
</pre></div><div class="refsect1" title="Description"><a name="gdbus-interface-com-hubic-settings"></a><h2>Description</h2><p></p></div><div class="refsect1" title="Method Details"><a name="gdbus-methods-com.hubic.settings"></a><h2>Method Details</h2><div class="refsect2" title="The GetSetting() method"><a name="gdbus-method-com-hubic-settings.GetSetting"></a><h3>The GetSetting() method</h3><a class="indexterm" name="idp5185920"></a><pre class="programlisting">
GetSetting (IN s setting,
OUT s ret);
</pre><p> Retriees a setting value as string.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>setting</code></em></code>:</span></dt><dd><p>name of a property.</p></dd><dt><span class="term"><code class="literal">OUT s <em class="parameter"><code>ret</code></em></code>:</span></dt><dd><p>setting value serialized as string.</p></dd></dl></div></div><div class="refsect2" title="The SetSetting() method"><a name="gdbus-method-com-hubic-settings.SetSetting"></a><h3>The SetSetting() method</h3><a class="indexterm" name="idp6410128"></a><pre class="programlisting">
SetSetting (IN s setting,
IN s value);
</pre><p> Set a setting value with a serialized string. As string serialization
method is implementation defined, this method should be avoided.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>setting</code></em></code>:</span></dt><dd><p>name of a property.</p></dd><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>value</code></em></code>:</span></dt><dd><p>new setting value serialized as string.</p></dd></dl></div></div><div class="refsect2" title="The SetProxy() method"><a name="gdbus-method-com-hubic-settings.SetProxy"></a><h3>The SetProxy() method</h3><a class="indexterm" name="idp9238144"></a><pre class="programlisting">
SetProxy (IN s hostname,
IN i port);
</pre><p> Install a new unauthenticated proxy. Overwrites any previous proxy
configuration.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>hostname</code></em></code>:</span></dt><dd><p>host name or IP address of the new proxy.</p></dd><dt><span class="term"><code class="literal">IN i <em class="parameter"><code>port</code></em></code>:</span></dt><dd><p>port of the new proxy.</p></dd></dl></div></div><div class="refsect2" title="The SetAuthenticatedProxy() method"><a name="gdbus-method-com-hubic-settings.SetAuthenticatedProxy"></a><h3>The SetAuthenticatedProxy() method</h3><a class="indexterm" name="idp5168448"></a><pre class="programlisting">
SetAuthenticatedProxy (IN s hostname,
IN i port,
IN s username,
IN s password);
</pre><p> Installs a new authenticated proxy. Overwrites any previous proxy
configuration.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>hostname</code></em></code>:</span></dt><dd><p>host name or IP address of the new proxy.</p></dd><dt><span class="term"><code class="literal">IN i <em class="parameter"><code>port</code></em></code>:</span></dt><dd><p>port of the new proxy.</p></dd><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>username</code></em></code>:</span></dt><dd><p></p></dd><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>password</code></em></code>:</span></dt><dd><p></p></dd></dl></div></div><div class="refsect2" title="The UnsetProxy() method"><a name="gdbus-method-com-hubic-settings.UnsetProxy"></a><h3>The UnsetProxy() method</h3><a class="indexterm" name="idp9499104"></a><pre class="programlisting">
UnsetProxy ();
</pre><p> Reset proxy configuration to direct Internet access.
</p><div class="variablelist"><dl></dl></div></div></div><div class="refsect1" title="Property Details"><a name="gdbus-properties-com.hubic.settings"></a><h2>Property Details</h2><div class="refsect2" title='The "TimeBetweenSynchronization" property'><a name="gdbus-property-com-hubic-settings.TimeBetweenSynchronization"></a><h3>The "TimeBetweenSynchronization" property</h3><a class="indexterm" name="idp9505680"></a><pre class="programlisting">
TimeBetweenSynchronization readwrite u
</pre><p> Interval between two complete synchronization cycles in minutes. Note that
local changes are detected immediately and trigger partial synchronizations
independentely of this setting.
</p></div><div class="refsect2" title='The "UseRecycleBin" property'><a name="gdbus-property-com-hubic-settings.UseRecycleBin"></a><h3>The "UseRecycleBin" property</h3><a class="indexterm" name="idp9509792"></a><pre class="programlisting">
UseRecycleBin readwrite b
</pre><p> Whether locally deleted files are placed in recylce bin or deleted directly.
<span class="emphasis"><em>Trash can is not yet implemented under Linux !</em></span>
</p></div><div class="refsect2" title='The "AllowBugReporting" property'><a name="gdbus-property-com-hubic-settings.AllowBugReporting"></a><h3>The "AllowBugReporting" property</h3><a class="indexterm" name="idp9514304"></a><pre class="programlisting">
AllowBugReporting readwrite b
</pre><p> Whether automated bug reports are sent over unexpected errors.
</p></div><div class="refsect2" title='The "UploadSpeedLimit" property'><a name="gdbus-property-com-hubic-settings.UploadSpeedLimit"></a><h3>The "UploadSpeedLimit" property</h3><a class="indexterm" name="idp9518480"></a><pre class="programlisting">
UploadSpeedLimit readwrite x
</pre><p> Maximum upload speed in bytes per second (0 means unlimited).
</p></div><div class="refsect2" title='The "DownloadSpeedLimit" property'><a name="gdbus-property-com-hubic-settings.DownloadSpeedLimit"></a><h3>The "DownloadSpeedLimit" property</h3><a class="indexterm" name="idp9522656"></a><pre class="programlisting">
DownloadSpeedLimit readwrite x
</pre><p> Maximum download speed in bytes per second (0 means unlimited).
</p></div><div class="refsect2" title='The "ProxyEnabled" property'><a name="gdbus-property-com-hubic-settings.ProxyEnabled"></a><h3>The "ProxyEnabled" property</h3><a class="indexterm" name="idp9526832"></a><pre class="programlisting">
ProxyEnabled readable b
</pre><p> Whether or not a proxy is currently enabled.
</p></div><div class="refsect2" title='The "ProxyHost" property'><a name="gdbus-property-com-hubic-settings.ProxyHost"></a><h3>The "ProxyHost" property</h3><a class="indexterm" name="idp9530928"></a><pre class="programlisting">
ProxyHost readable s
</pre><p> Current proxy host or IP address. (Empty string if proxy is disabled)
</p></div><div class="refsect2" title='The "ProxyPort" property'><a name="gdbus-property-com-hubic-settings.ProxyPort"></a><h3>The "ProxyPort" property</h3><a class="indexterm" name="idp9535024"></a><pre class="programlisting">
ProxyPort readable i
</pre><p> Current proxy port. (0 if proxy is disabled)
</p></div><div class="refsect2" title='The "ProxyUsername" property'><a name="gdbus-property-com-hubic-settings.ProxyUsername"></a><h3>The "ProxyUsername" property</h3><a class="indexterm" name="idp9539120"></a><pre class="programlisting">
ProxyUsername readable s
</pre><p> Current proxy user name. (Empty string if proxy disabled or does not need
authentication.
</p></div></div></div><div class="refentry" title="com.hubic.backup"><div class="refentry.separator"><hr></div><a name="gdbus-com.hubic.backup"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>com.hubic.backup — Controls backup state and settings.</p></div><div class="refsynopsisdiv" title="Methods"><h2>Methods</h2><pre class="synopsis">
<a class="link" href="#gdbus-method-com-hubic-backup.BackupNow" title="The BackupNow() method">BackupNow</a> ();
<a class="link" href="#gdbus-method-com-hubic-backup.DownloadInto" title="The DownloadInto() method">DownloadInto</a> (IN s localPath);
<a class="link" href="#gdbus-method-com-hubic-backup.AttachToThisComputer" title="The AttachToThisComputer() method">AttachToThisComputer</a> (IN s localPath);
<a class="link" href="#gdbus-method-com-hubic-backup.Delete" title="The Delete() method">Delete</a> ();
</pre></div><div class="refsect1" title="Properties"><a name="idp8529104"></a><h2>Properties</h2><pre class="synopsis">
<a class="link" href="#gdbus-property-com-hubic-backup.Name" title='The "Name" property'>Name</a> readable s
<a class="link" href="#gdbus-property-com-hubic-backup.Owned" title='The "Owned" property'>Owned</a> readable b
<a class="link" href="#gdbus-property-com-hubic-backup.LastBackup" title='The "LastBackup" property'>LastBackup</a> readable x
<a class="link" href="#gdbus-property-com-hubic-backup.Size" title='The "Size" property'>Size</a> readable x
<a class="link" href="#gdbus-property-com-hubic-backup.LocalPath" title='The "LocalPath" property'>LocalPath</a> readwrite s
<a class="link" href="#gdbus-property-com-hubic-backup.BackupInProgress" title='The "BackupInProgress" property'>BackupInProgress</a> readable b
<a class="link" href="#gdbus-property-com-hubic-backup.Frequency" title='The "Frequency" property'>Frequency</a> readwrite s
<a class="link" href="#gdbus-property-com-hubic-backup.DeletePolicy" title='The "DeletePolicy" property'>DeletePolicy</a> readwrite s
<a class="link" href="#gdbus-property-com-hubic-backup.VersionsKept" title='The "VersionsKept" property'>VersionsKept</a> readwrite i
</pre></div><div class="refsect1" title="Description"><a name="gdbus-interface-com-hubic-backup"></a><h2>Description</h2><p> For each backup, an object of this interface is available under the path
<code class="literal">/com/hubic/Backup/<name></code>.
</p><p> Objects of this type does ont exists in <code class="constant">NotConnected</code> or <code class="constant">Connecting</code>
states.
</p><p> Note that the backup are attached to only one client (see the man page
for details). This is reflected by the com.hubic.backup::Owned attribute.
Some operations are allowed only for owned backups (otherwise they would
raise errors).
</p></div><div class="refsect1" title="Method Details"><a name="gdbus-methods-com.hubic.backup"></a><h2>Method Details</h2><div class="refsect2" title="The BackupNow() method"><a name="gdbus-method-com-hubic-backup.BackupNow"></a><h3>The BackupNow() method</h3><a class="indexterm" name="idp8558000"></a><pre class="programlisting">
BackupNow ();
</pre><p> Triggers an immediate update of the backup. The backup needs to be owned.
</p><div class="variablelist"><dl></dl></div></div><div class="refsect2" title="The DownloadInto() method"><a name="gdbus-method-com-hubic-backup.DownloadInto"></a><h3>The DownloadInto() method</h3><a class="indexterm" name="idp8562800"></a><pre class="programlisting">
DownloadInto (IN s localPath);
</pre><p> Triggers the download of the backup into given local folder. This method
is asynchronous and return immediately.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>localPath</code></em></code>:</span></dt><dd><p>the local path to download into. Needs to be an empty folder.</p></dd></dl></div></div><div class="refsect2" title="The AttachToThisComputer() method"><a name="gdbus-method-com-hubic-backup.AttachToThisComputer"></a><h3>The AttachToThisComputer() method</h3><a class="indexterm" name="idp8881248"></a><pre class="programlisting">
AttachToThisComputer (IN s localPath);
</pre><p> Attach a unowned backup to local folder. See man page for details about
backup ownership.
</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">IN s <em class="parameter"><code>localPath</code></em></code>:</span></dt><dd><p>the local path to attach to.</p></dd></dl></div></div><div class="refsect2" title="The Delete() method"><a name="gdbus-method-com-hubic-backup.Delete"></a><h3>The Delete() method</h3><a class="indexterm" name="idp9185168"></a><pre class="programlisting">
Delete ();
</pre><p> Triggers the deletion of the backup and all attached files. This method
is asynchronous and return immediately.
</p><div class="variablelist"><dl></dl></div></div></div><div class="refsect1" title="Property Details"><a name="gdbus-properties-com.hubic.backup"></a><h2>Property Details</h2><div class="refsect2" title='The "Name" property'><a name="gdbus-property-com-hubic-backup.Name"></a><h3>The "Name" property</h3><a class="indexterm" name="idp9192000"></a><pre class="programlisting">
Name readable s
</pre><p> Unique backup name. It can be set only at creation time.
</p></div><div class="refsect2" title='The "Owned" property'><a name="gdbus-property-com-hubic-backup.Owned"></a><h3>The "Owned" property</h3><a class="indexterm" name="idp5470368"></a><pre class="programlisting">
Owned readable b
</pre><p> Whether or not the backup is attached on this client.
</p></div><div class="refsect2" title='The "LastBackup" property'><a name="gdbus-property-com-hubic-backup.LastBackup"></a><h3>The "LastBackup" property</h3><a class="indexterm" name="idp5474416"></a><pre class="programlisting">
LastBackup readable x
</pre><p> UNIX timestamp of the last full backup cycle. Can be -1 if the backup is
in progress (this also include new backups).
</p></div><div class="refsect2" title='The "Size" property'><a name="gdbus-property-com-hubic-backup.Size"></a><h3>The "Size" property</h3><a class="indexterm" name="idp5478784"></a><pre class="programlisting">
Size readable x
</pre><p> Size of the backup in bytes. Note this does not reflect the size of the
local folder, as versions are counted too and some data compression could
occur.
</p></div><div class="refsect2" title='The "LocalPath" property'><a name="gdbus-property-com-hubic-backup.LocalPath"></a><h3>The "LocalPath" property</h3><a class="indexterm" name="idp5483024"></a><pre class="programlisting">
LocalPath readwrite s
</pre><p> Local backup path. It can be changed to another folder, this will
trigger an update.
</p></div><div class="refsect2" title='The "BackupInProgress" property'><a name="gdbus-property-com-hubic-backup.BackupInProgress"></a><h3>The "BackupInProgress" property</h3><a class="indexterm" name="idp5487232"></a><pre class="programlisting">
BackupInProgress readable b
</pre><p> Whether or not a backup is in progress.
</p></div><div class="refsect2" title='The "Frequency" property'><a name="gdbus-property-com-hubic-backup.Frequency"></a><h3>The "Frequency" property</h3><a class="indexterm" name="idp5491328"></a><pre class="programlisting">
Frequency readwrite s
</pre><p> The automatic backup frequency. This must br one of "never", "hourly",
"daily", "weekly" (case insensitive).
</p></div><div class="refsect2" title='The "DeletePolicy" property'><a name="gdbus-property-com-hubic-backup.DeletePolicy"></a><h3>The "DeletePolicy" property</h3><a class="indexterm" name="idp5495568"></a><pre class="programlisting">
DeletePolicy readwrite s
</pre><p> The behavior when a file is deleted. It must be one of "keep" (do not
delete files on hubiC), "delete" (forward delete to hubiC).
</p></div><div class="refsect2" title='The "VersionsKept" property'><a name="gdbus-property-com-hubic-backup.VersionsKept"></a><h3>The "VersionsKept" property</h3><a class="indexterm" name="idp5499824"></a><pre class="programlisting">
VersionsKept readwrite i
</pre><p> Number of older versions to keep. 0 means no versioning, a negative
number means infinite versioning.
</p></div></div></div></div></body></html>
Mini Shell