%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.settings.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.settings">
  <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-com-hubic-settings.top_of_page">com.hubic.settings</refentrytitle>
  <indexterm zone="gdbus-interface-com-hubic-settings.top_of_page"><primary sortas="com.hubic.settings">com.hubic.settings</primary></indexterm>
  </refmeta>  <refnamediv>    <refname>com.hubic.settings</refname>    <refpurpose></refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
    <title role="synopsis.title">Methods</title>
    <synopsis>
<link linkend="gdbus-method-com-hubic-settings.GetSetting">GetSetting</link>            (IN  s setting,
                       OUT s ret);
<link linkend="gdbus-method-com-hubic-settings.SetSetting">SetSetting</link>            (IN  s setting,
                       IN  s value);
<link linkend="gdbus-method-com-hubic-settings.SetProxy">SetProxy</link>              (IN  s hostname,
                       IN  i port);
<link linkend="gdbus-method-com-hubic-settings.SetAuthenticatedProxy">SetAuthenticatedProxy</link> (IN  s hostname,
                       IN  i port,
                       IN  s username,
                       IN  s password);
<link linkend="gdbus-method-com-hubic-settings.UnsetProxy">UnsetProxy</link>            ();
</synopsis>
  </refsynopsisdiv>
  <refsect1 role="properties">
    <title role="properties.title">Properties</title>
    <synopsis>
<link linkend="gdbus-property-com-hubic-settings.TimeBetweenSynchronization">TimeBetweenSynchronization</link>  readwrite  u
<link linkend="gdbus-property-com-hubic-settings.UseRecycleBin">UseRecycleBin</link>               readwrite  b
<link linkend="gdbus-property-com-hubic-settings.AllowBugReporting">AllowBugReporting</link>           readwrite  b
<link linkend="gdbus-property-com-hubic-settings.UploadSpeedLimit">UploadSpeedLimit</link>            readwrite  x
<link linkend="gdbus-property-com-hubic-settings.DownloadSpeedLimit">DownloadSpeedLimit</link>          readwrite  x
<link linkend="gdbus-property-com-hubic-settings.ProxyEnabled">ProxyEnabled</link>                readable   b
<link linkend="gdbus-property-com-hubic-settings.ProxyHost">ProxyHost</link>                   readable   s
<link linkend="gdbus-property-com-hubic-settings.ProxyPort">ProxyPort</link>                   readable   i
<link linkend="gdbus-property-com-hubic-settings.ProxyUsername">ProxyUsername</link>               readable   s
</synopsis>
  </refsect1>
<refsect1 role="desc" id="gdbus-interface-com-hubic-settings">
  <title role="desc.title">Description</title>
  <para></para>
</refsect1>
<refsect1 role="details" id="gdbus-methods-com.hubic.settings">
  <title role="details.title">Method Details</title>
<refsect2 role="method" id="gdbus-method-com-hubic-settings.GetSetting">
  <title>The GetSetting() method</title>
  <indexterm zone="gdbus-method-com-hubic-settings.GetSetting"><primary sortas="com.hubic.settings.GetSetting">com.hubic.settings.GetSetting()</primary></indexterm>
<programlisting>
GetSetting (IN  s setting,
            OUT s ret);
</programlisting>
<para><para>      Retriees a setting value as string.
</para></para>
<variablelist role="params">
<varlistentry>
  <term><literal>IN s <parameter>setting</parameter></literal>:</term>
  <listitem><para>name of a property.</para></listitem>
</varlistentry>
<varlistentry>
  <term><literal>OUT s <parameter>ret</parameter></literal>:</term>
  <listitem><para>setting value serialized as string.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-com-hubic-settings.SetSetting">
  <title>The SetSetting() method</title>
  <indexterm zone="gdbus-method-com-hubic-settings.SetSetting"><primary sortas="com.hubic.settings.SetSetting">com.hubic.settings.SetSetting()</primary></indexterm>
<programlisting>
SetSetting (IN  s setting,
            IN  s value);
</programlisting>
<para><para>      Set a setting value with a serialized string. As string serialization
      method is implementation defined, this method should be avoided.
</para></para>
<variablelist role="params">
<varlistentry>
  <term><literal>IN s <parameter>setting</parameter></literal>:</term>
  <listitem><para>name of a property.</para></listitem>
</varlistentry>
<varlistentry>
  <term><literal>IN s <parameter>value</parameter></literal>:</term>
  <listitem><para>new setting value serialized as string.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-com-hubic-settings.SetProxy">
  <title>The SetProxy() method</title>
  <indexterm zone="gdbus-method-com-hubic-settings.SetProxy"><primary sortas="com.hubic.settings.SetProxy">com.hubic.settings.SetProxy()</primary></indexterm>
<programlisting>
SetProxy (IN  s hostname,
          IN  i port);
</programlisting>
<para><para>      Install a new unauthenticated proxy. Overwrites any previous proxy
      configuration.
</para></para>
<variablelist role="params">
<varlistentry>
  <term><literal>IN s <parameter>hostname</parameter></literal>:</term>
  <listitem><para>host name or IP address of the new proxy.</para></listitem>
</varlistentry>
<varlistentry>
  <term><literal>IN i <parameter>port</parameter></literal>:</term>
  <listitem><para>port of the new proxy.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-com-hubic-settings.SetAuthenticatedProxy">
  <title>The SetAuthenticatedProxy() method</title>
  <indexterm zone="gdbus-method-com-hubic-settings.SetAuthenticatedProxy"><primary sortas="com.hubic.settings.SetAuthenticatedProxy">com.hubic.settings.SetAuthenticatedProxy()</primary></indexterm>
<programlisting>
SetAuthenticatedProxy (IN  s hostname,
                       IN  i port,
                       IN  s username,
                       IN  s password);
</programlisting>
<para><para>      Installs a new authenticated proxy. Overwrites any previous proxy
      configuration.
</para></para>
<variablelist role="params">
<varlistentry>
  <term><literal>IN s <parameter>hostname</parameter></literal>:</term>
  <listitem><para>host name or IP address of the new proxy.</para></listitem>
</varlistentry>
<varlistentry>
  <term><literal>IN i <parameter>port</parameter></literal>:</term>
  <listitem><para>port of the new proxy.</para></listitem>
</varlistentry>
<varlistentry>
  <term><literal>IN s <parameter>username</parameter></literal>:</term>
  <listitem><para></para></listitem>
</varlistentry>
<varlistentry>
  <term><literal>IN s <parameter>password</parameter></literal>:</term>
  <listitem><para></para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-com-hubic-settings.UnsetProxy">
  <title>The UnsetProxy() method</title>
  <indexterm zone="gdbus-method-com-hubic-settings.UnsetProxy"><primary sortas="com.hubic.settings.UnsetProxy">com.hubic.settings.UnsetProxy()</primary></indexterm>
<programlisting>
UnsetProxy ();
</programlisting>
<para><para>      Reset proxy configuration to direct Internet access.
</para></para>
<variablelist role="params">
</variablelist>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-properties-com.hubic.settings">
  <title role="details.title">Property Details</title>
<refsect2 role="property" id="gdbus-property-com-hubic-settings.TimeBetweenSynchronization">
  <title>The "TimeBetweenSynchronization" property</title>
  <indexterm zone="gdbus-property-com-hubic-settings.TimeBetweenSynchronization"><primary sortas="com.hubic.settings:TimeBetweenSynchronization">com.hubic.settings:TimeBetweenSynchronization</primary></indexterm>
<programlisting>
TimeBetweenSynchronization  readwrite  u
</programlisting>
<para><para>    Interval between two complete synchronization cycles in minutes. Note that
    local changes are detected immediately and trigger partial synchronizations
    independentely of this setting.
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-settings.UseRecycleBin">
  <title>The "UseRecycleBin" property</title>
  <indexterm zone="gdbus-property-com-hubic-settings.UseRecycleBin"><primary sortas="com.hubic.settings:UseRecycleBin">com.hubic.settings:UseRecycleBin</primary></indexterm>
<programlisting>
UseRecycleBin  readwrite  b
</programlisting>
<para><para>    Whether locally deleted files are placed in recylce bin or deleted directly.
    <emphasis>Trash can is not yet implemented under Linux !</emphasis>
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-settings.AllowBugReporting">
  <title>The "AllowBugReporting" property</title>
  <indexterm zone="gdbus-property-com-hubic-settings.AllowBugReporting"><primary sortas="com.hubic.settings:AllowBugReporting">com.hubic.settings:AllowBugReporting</primary></indexterm>
<programlisting>
AllowBugReporting  readwrite  b
</programlisting>
<para><para>    Whether automated bug reports are sent over unexpected errors.
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-settings.UploadSpeedLimit">
  <title>The "UploadSpeedLimit" property</title>
  <indexterm zone="gdbus-property-com-hubic-settings.UploadSpeedLimit"><primary sortas="com.hubic.settings:UploadSpeedLimit">com.hubic.settings:UploadSpeedLimit</primary></indexterm>
<programlisting>
UploadSpeedLimit  readwrite  x
</programlisting>
<para><para>    Maximum upload speed in bytes per second (0 means unlimited).
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-settings.DownloadSpeedLimit">
  <title>The "DownloadSpeedLimit" property</title>
  <indexterm zone="gdbus-property-com-hubic-settings.DownloadSpeedLimit"><primary sortas="com.hubic.settings:DownloadSpeedLimit">com.hubic.settings:DownloadSpeedLimit</primary></indexterm>
<programlisting>
DownloadSpeedLimit  readwrite  x
</programlisting>
<para><para>    Maximum download speed in bytes per second (0 means unlimited).
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-settings.ProxyEnabled">
  <title>The "ProxyEnabled" property</title>
  <indexterm zone="gdbus-property-com-hubic-settings.ProxyEnabled"><primary sortas="com.hubic.settings:ProxyEnabled">com.hubic.settings:ProxyEnabled</primary></indexterm>
<programlisting>
ProxyEnabled  readable   b
</programlisting>
<para><para>    Whether or not a proxy is currently enabled.
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-settings.ProxyHost">
  <title>The "ProxyHost" property</title>
  <indexterm zone="gdbus-property-com-hubic-settings.ProxyHost"><primary sortas="com.hubic.settings:ProxyHost">com.hubic.settings:ProxyHost</primary></indexterm>
<programlisting>
ProxyHost  readable   s
</programlisting>
<para><para>    Current proxy host or IP address. (Empty string if proxy is disabled)
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-settings.ProxyPort">
  <title>The "ProxyPort" property</title>
  <indexterm zone="gdbus-property-com-hubic-settings.ProxyPort"><primary sortas="com.hubic.settings:ProxyPort">com.hubic.settings:ProxyPort</primary></indexterm>
<programlisting>
ProxyPort  readable   i
</programlisting>
<para><para>    Current proxy port. (0 if proxy is disabled)
</para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-com-hubic-settings.ProxyUsername">
  <title>The "ProxyUsername" property</title>
  <indexterm zone="gdbus-property-com-hubic-settings.ProxyUsername"><primary sortas="com.hubic.settings:ProxyUsername">com.hubic.settings:ProxyUsername</primary></indexterm>
<programlisting>
ProxyUsername  readable   s
</programlisting>
<para><para>    Current proxy user name. (Empty string if proxy disabled or does not need
    authentication.
</para></para>
</refsect2>
</refsect1>
</refentry>

Zerion Mini Shell 1.0