%PDF- %PDF-
Mini Shell

Mini Shell

Direktori : /data/old/usr/local/share/doc/hubic/dbusapi/
Upload File :
Create Path :
Current File : //data/old/usr/local/share/doc/hubic/dbusapi/dbusapi.docbook-com.hubic.backup.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.backup">
  <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-com-hubic-backup.top_of_page">com.hubic.backup</refentrytitle>
  <indexterm zone="gdbus-interface-com-hubic-backup.top_of_page"><primary sortas="com.hubic.backup">com.hubic.backup</primary></indexterm>
  </refmeta>  <refnamediv>    <refname>com.hubic.backup</refname>    <refpurpose>Controls backup state and settings.</refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
    <title role="synopsis.title">Methods</title>
    <synopsis>
<link linkend="gdbus-method-com-hubic-backup.BackupNow">BackupNow</link>            ();
<link linkend="gdbus-method-com-hubic-backup.DownloadInto">DownloadInto</link>         (IN  s localPath);
<link linkend="gdbus-method-com-hubic-backup.AttachToThisComputer">AttachToThisComputer</link> (IN  s localPath);
<link linkend="gdbus-method-com-hubic-backup.Delete">Delete</link>               ();
</synopsis>
  </refsynopsisdiv>
  <refsect1 role="properties">
    <title role="properties.title">Properties</title>
    <synopsis>
<link linkend="gdbus-property-com-hubic-backup.Name">Name</link>              readable   s
<link linkend="gdbus-property-com-hubic-backup.Owned">Owned</link>             readable   b
<link linkend="gdbus-property-com-hubic-backup.LastBackup">LastBackup</link>        readable   x
<link linkend="gdbus-property-com-hubic-backup.Size">Size</link>              readable   x
<link linkend="gdbus-property-com-hubic-backup.LocalPath">LocalPath</link>         readwrite  s
<link linkend="gdbus-property-com-hubic-backup.BackupInProgress">BackupInProgress</link>  readable   b
<link linkend="gdbus-property-com-hubic-backup.Frequency">Frequency</link>         readwrite  s
<link linkend="gdbus-property-com-hubic-backup.DeletePolicy">DeletePolicy</link>      readwrite  s
<link linkend="gdbus-property-com-hubic-backup.VersionsKept">VersionsKept</link>      readwrite  i
</synopsis>
  </refsect1>
<refsect1 role="desc" id="gdbus-interface-com-hubic-backup">
  <title role="desc.title">Description</title>
  <para><para>    For each backup, an object of this interface is available under the path
    <literal>/com/hubic/Backup/&lt;name&gt;</literal>.
</para><para>    Objects of this type does ont exists in <constant>NotConnected</constant> or <constant>Connecting</constant>
    states.
</para><para>    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).
</para></para>
</refsect1>
<refsect1 role="details" id="gdbus-methods-com.hubic.backup">
  <title role="details.title">Method Details</title>
<refsect2 role="method" id="gdbus-method-com-hubic-backup.BackupNow">
  <title>The BackupNow() method</title>
  <indexterm zone="gdbus-method-com-hubic-backup.BackupNow"><primary sortas="com.hubic.backup.BackupNow">com.hubic.backup.BackupNow()</primary></indexterm>
<programlisting>
BackupNow ();
</programlisting>
<para><para>      Triggers an immediate update of the backup. The backup needs to be owned.
</para></para>
<variablelist role="params">
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-com-hubic-backup.DownloadInto">
  <title>The DownloadInto() method</title>
  <indexterm zone="gdbus-method-com-hubic-backup.DownloadInto"><primary sortas="com.hubic.backup.DownloadInto">com.hubic.backup.DownloadInto()</primary></indexterm>
<programlisting>
DownloadInto (IN  s localPath);
</programlisting>
<para><para>      Triggers the download of the backup into given local folder. This method
      is asynchronous and return immediately.
</para></para>
<variablelist role="params">
<varlistentry>
  <term><literal>IN s <parameter>localPath</parameter></literal>:</term>
  <listitem><para>the local path to download into. Needs to be an empty folder.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-com-hubic-backup.AttachToThisComputer">
  <title>The AttachToThisComputer() method</title>
  <indexterm zone="gdbus-method-com-hubic-backup.AttachToThisComputer"><primary sortas="com.hubic.backup.AttachToThisComputer">com.hubic.backup.AttachToThisComputer()</primary></indexterm>
<programlisting>
AttachToThisComputer (IN  s localPath);
</programlisting>
<para><para>      Attach a unowned backup to local folder. See man page for details about
      backup ownership.
</para></para>
<variablelist role="params">
<varlistentry>
  <term><literal>IN s <parameter>localPath</parameter></literal>:</term>
  <listitem><para>the local path to attach to.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-com-hubic-backup.Delete">
  <title>The Delete() method</title>
  <indexterm zone="gdbus-method-com-hubic-backup.Delete"><primary sortas="com.hubic.backup.Delete">com.hubic.backup.Delete()</primary></indexterm>
<programlisting>
Delete ();
</programlisting>
<para><para>      Triggers the deletion of the backup and all attached files. This method
      is asynchronous and return immediately.
</para></para>
<variablelist role="params">
</variablelist>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-properties-com.hubic.backup">
  <title role="details.title">Property Details</title>
<refsect2 role="property" id="gdbus-property-com-hubic-backup.Name">
  <title>The "Name" property</title>
  <indexterm zone="gdbus-property-com-hubic-backup.Name"><primary sortas="com.hubic.backup:Name">com.hubic.backup:Name</primary></indexterm>
<programlisting>
Name  readable   s
</programlisting>
<para><para>      Unique backup name. It can be set only at creation time.
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-backup.Owned">
  <title>The "Owned" property</title>
  <indexterm zone="gdbus-property-com-hubic-backup.Owned"><primary sortas="com.hubic.backup:Owned">com.hubic.backup:Owned</primary></indexterm>
<programlisting>
Owned  readable   b
</programlisting>
<para><para>      Whether or not the backup is attached on this client.
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-backup.LastBackup">
  <title>The "LastBackup" property</title>
  <indexterm zone="gdbus-property-com-hubic-backup.LastBackup"><primary sortas="com.hubic.backup:LastBackup">com.hubic.backup:LastBackup</primary></indexterm>
<programlisting>
LastBackup  readable   x
</programlisting>
<para><para>      UNIX timestamp of the last full backup cycle. Can be -1 if the backup is
      in progress (this also include new backups).
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-backup.Size">
  <title>The "Size" property</title>
  <indexterm zone="gdbus-property-com-hubic-backup.Size"><primary sortas="com.hubic.backup:Size">com.hubic.backup:Size</primary></indexterm>
<programlisting>
Size  readable   x
</programlisting>
<para><para>      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.
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-backup.LocalPath">
  <title>The "LocalPath" property</title>
  <indexterm zone="gdbus-property-com-hubic-backup.LocalPath"><primary sortas="com.hubic.backup:LocalPath">com.hubic.backup:LocalPath</primary></indexterm>
<programlisting>
LocalPath  readwrite  s
</programlisting>
<para><para>      Local backup path. It can be changed to another folder, this will
      trigger an update.
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-backup.BackupInProgress">
  <title>The "BackupInProgress" property</title>
  <indexterm zone="gdbus-property-com-hubic-backup.BackupInProgress"><primary sortas="com.hubic.backup:BackupInProgress">com.hubic.backup:BackupInProgress</primary></indexterm>
<programlisting>
BackupInProgress  readable   b
</programlisting>
<para><para>      Whether or not a backup is in progress.
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-backup.Frequency">
  <title>The "Frequency" property</title>
  <indexterm zone="gdbus-property-com-hubic-backup.Frequency"><primary sortas="com.hubic.backup:Frequency">com.hubic.backup:Frequency</primary></indexterm>
<programlisting>
Frequency  readwrite  s
</programlisting>
<para><para>      The automatic backup frequency. This must br one of "never", "hourly",
      "daily", "weekly" (case insensitive).
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-backup.DeletePolicy">
  <title>The "DeletePolicy" property</title>
  <indexterm zone="gdbus-property-com-hubic-backup.DeletePolicy"><primary sortas="com.hubic.backup:DeletePolicy">com.hubic.backup:DeletePolicy</primary></indexterm>
<programlisting>
DeletePolicy  readwrite  s
</programlisting>
<para><para>      The behavior when a file is deleted. It must be one of "keep" (do not
      delete files on hubiC), "delete" (forward delete to hubiC).
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-backup.VersionsKept">
  <title>The "VersionsKept" property</title>
  <indexterm zone="gdbus-property-com-hubic-backup.VersionsKept"><primary sortas="com.hubic.backup:VersionsKept">com.hubic.backup:VersionsKept</primary></indexterm>
<programlisting>
VersionsKept  readwrite  i
</programlisting>
<para><para>      Number of older versions to keep. 0 means no versioning, a negative
      number means infinite versioning.
</para></para>
</refsect2>
</refsect1>
</refentry>

Zerion Mini Shell 1.0