← Back to branch summary

~ubuntu-branches/ubuntu/saucy/evolution-data-server/saucy

« back to all changes in this revision

Viewing changes to docs/reference/libebackend/html/EServerSideSource.html

  • Committer: Package Import Robot
  • Author(s): Chris Coulson
  • Date: 2012-10-08 12:58:16 UTC
  • mfrom: (181.1.7 quantal)
  • Revision ID: package-import@ubuntu.com-20121008125816-i3n76e8c0m64e7xp
Tags: 3.6.0-0ubuntu2
https://launchpad.net/bugs/1038047
https://launchpad.net/bugs/1038047
* Fix LP: #1038047 part 1 - Don't abort in e_source_registry_new* when a
  problem occurs connecting to the Dbus service
  - add debian/patches/dont-abort-in-e_source_registry_new.patch
  - update debian/patches/series
* Fix LP: #1038047 part 2 - libedataserver depends on
  evolution-data-server-common to ensure that the GSettings schemas are
  present
  - update debian/control

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libebackend/html/EServerSideSource.html
51
51
<span class="returnvalue">GFile</span> *             <a class="link" href="EServerSideSource.html#e-server-side-source-new-user-file" title="e_server_side_source_new_user_file ()">e_server_side_source_new_user_file</a>  (<em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);
52
52
<span class="returnvalue">gchar</span> *             <a class="link" href="EServerSideSource.html#e-server-side-source-uid-from-file" title="e_server_side_source_uid_from_file ()">e_server_side_source_uid_from_file</a>  (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
53
53
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
54
 
<span class="returnvalue">ESource</span> *           <a class="link" href="EServerSideSource.html#e-server-side-source-new" title="e_server_side_source_new ()">e_server_side_source_new</a>            (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
54
<a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           <a class="link" href="EServerSideSource.html#e-server-side-source-new" title="e_server_side_source_new ()">e_server_side_source_new</a>            (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
55
55
                                                         <em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
56
56
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
57
 
<span class="returnvalue">ESource</span> *           <a class="link" href="EServerSideSource.html#e-server-side-source-new-memory-only" title="e_server_side_source_new_memory_only ()">e_server_side_source_new_memory_only</a>
 
57
<a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           <a class="link" href="EServerSideSource.html#e-server-side-source-new-memory-only" title="e_server_side_source_new_memory_only ()">e_server_side_source_new_memory_only</a>
58
58
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
59
59
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
60
60
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
79
79
                                                         <em class="parameter"><code><span class="type">gboolean</span> removable</code></em>);
80
80
<span class="returnvalue">void</span>                <a class="link" href="EServerSideSource.html#e-server-side-source-set-writable" title="e_server_side_source_set_writable ()">e_server_side_source_set_writable</a>   (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
81
81
                                                         <em class="parameter"><code><span class="type">gboolean</span> writable</code></em>);
 
82
<span class="returnvalue">void</span>                <a class="link" href="EServerSideSource.html#e-server-side-source-set-remote-creatable" title="e_server_side_source_set_remote_creatable ()">e_server_side_source_set_remote_creatable</a>
 
83
                                                        (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
 
84
                                                         <em class="parameter"><code><span class="type">gboolean</span> remote_creatable</code></em>);
 
85
<span class="returnvalue">void</span>                <a class="link" href="EServerSideSource.html#e-server-side-source-set-remote-deletable" title="e_server_side_source_set_remote_deletable ()">e_server_side_source_set_remote_deletable</a>
 
86
                                                        (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
 
87
                                                         <em class="parameter"><code><span class="type">gboolean</span> remote_deletable</code></em>);
82
88
</pre>
83
89
</div>
84
90
<div class="refsect1">
85
91
<a name="EServerSideSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
86
92
<pre class="synopsis">
87
93
  GObject
88
 
   +----ESource
 
94
   +----<a href="../libedataserver/ESource.html">ESource</a>
89
95
         +----EServerSideSource
90
96
</pre>
91
97
</div>
101
107
  "<a class="link" href="EServerSideSource.html#EServerSideSource--allow-auth-prompt" title='The "allow-auth-prompt" property'>allow-auth-prompt</a>"        <span class="type">gboolean</span>              : Read / Write / Construct
102
108
  "<a class="link" href="EServerSideSource.html#EServerSideSource--exported" title='The "exported" property'>exported</a>"                 <span class="type">gboolean</span>              : Read
103
109
  "<a class="link" href="EServerSideSource.html#EServerSideSource--file" title='The "file" property'>file</a>"                     <span class="type">GFile</span>*                : Read / Write / Construct Only
 
110
  "<a class="link" href="EServerSideSource.html#EServerSideSource--remote-creatable" title='The "remote-creatable" property'>remote-creatable</a>"         <span class="type">gboolean</span>              : Read / Write
 
111
  "<a class="link" href="EServerSideSource.html#EServerSideSource--remote-deletable" title='The "remote-deletable" property'>remote-deletable</a>"         <span class="type">gboolean</span>              : Read / Write
104
112
  "<a class="link" href="EServerSideSource.html#EServerSideSource--removable" title='The "removable" property'>removable</a>"                <span class="type">gboolean</span>              : Read / Write
105
113
  "<a class="link" href="EServerSideSource.html#EServerSideSource--server" title='The "server" property'>server</a>"                   <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a>*  : Read / Write / Construct Only
106
 
  "<a class="link" href="EServerSideSource.html#EServerSideSource--uid" title='The "uid" property'>uid</a>"                      <span class="type">gchar</span>*                : Read / Write / Construct Only
107
114
  "<a class="link" href="EServerSideSource.html#EServerSideSource--writable" title='The "writable" property'>writable</a>"                 <span class="type">gboolean</span>              : Read / Write
108
115
  "<a class="link" href="EServerSideSource.html#EServerSideSource--write-directory" title='The "write-directory" property'>write-directory</a>"          <span class="type">gchar</span>*                : Read / Write
109
116
</pre>
111
118
<div class="refsect1">
112
119
<a name="EServerSideSource.description"></a><h2>Description</h2>
113
120
<p>
114
 
An <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> is an <span class="type">ESource</span> with some additional capabilities
 
121
An <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> is an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> with some additional capabilities
115
122
exclusive to the registry D-Bus service.
116
123
</p>
117
124
</div>
149
156
<p>
150
157
Generates a unique file name for a new user-specific data source.
151
158
If <em class="parameter"><code>uid</code></em> is non-<code class="literal">NULL</code> it will be used in the basename of the file,
152
 
otherwise a unique basename will be generated using <code class="function">e_uid_new()</code>.
 
159
otherwise a unique basename will be generated using <a href="../libedataserver/libedataserver-e-uid.html#e-uid-new"><code class="function">e_uid_new()</code></a>.
153
160
</p>
154
161
<p>
155
162
The returned <span class="type">GFile</span> can then be passed to <a class="link" href="EServerSideSource.html#e-server-side-source-new" title="e_server_side_source_new ()"><code class="function">e_server_side_source_new()</code></a>.
208
215
<hr>
209
216
<div class="refsect2">
210
217
<a name="e-server-side-source-new"></a><h3>e_server_side_source_new ()</h3>
211
 
<pre class="programlisting"><span class="returnvalue">ESource</span> *           e_server_side_source_new            (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
 
218
<pre class="programlisting"><a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           e_server_side_source_new            (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
212
219
                                                         <em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
213
220
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
214
221
<p>
247
254
<hr>
248
255
<div class="refsect2">
249
256
<a name="e-server-side-source-new-memory-only"></a><h3>e_server_side_source_new_memory_only ()</h3>
250
 
<pre class="programlisting"><span class="returnvalue">ESource</span> *           e_server_side_source_new_memory_only
 
257
<pre class="programlisting"><a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           e_server_side_source_new_memory_only
251
258
                                                        (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
252
259
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
253
260
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
641
648
</table></div>
642
649
<p class="since">Since 3.6</p>
643
650
</div>
 
651
<hr>
 
652
<div class="refsect2">
 
653
<a name="e-server-side-source-set-remote-creatable"></a><h3>e_server_side_source_set_remote_creatable ()</h3>
 
654
<pre class="programlisting"><span class="returnvalue">void</span>                e_server_side_source_set_remote_creatable
 
655
                                                        (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
 
656
                                                         <em class="parameter"><code><span class="type">gboolean</span> remote_creatable</code></em>);</pre>
 
657
<p>
 
658
Indicates whether <em class="parameter"><code>source</code></em> can be used to create resources on a remote
 
659
server.  Typically this is only set to <code class="literal">TRUE</code> for collection sources.
 
660
</p>
 
661
<p>
 
662
If <code class="literal">TRUE</code>, the RemoteCreatable D-Bus interface is exported at the object
 
663
path for <em class="parameter"><code>source</code></em>.  If <code class="literal">FALSE</code>, the RemoteCreatable D-Bus interface is
 
664
unexported at the object path for <em class="parameter"><code>source</code></em>, and any attempt by clients
 
665
to call <code class="function">e_source_remote_create()</code> will fail.
 
666
</p>
 
667
<p>
 
668
Unlike the <span class="type">"removable"</span> and <span class="type">"writable"</span> properties, this
 
669
is enforced for both clients of the registry D-Bus service and within
 
670
the registry D-Bus service itself.
 
671
</p>
 
672
<div class="variablelist"><table border="0">
 
673
<col align="left" valign="top">
 
674
<tbody>
 
675
<tr>
 
676
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
677
<td>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a>
 
678
</td>
 
679
</tr>
 
680
<tr>
 
681
<td><p><span class="term"><em class="parameter"><code>remote_creatable</code></em> :</span></p></td>
 
682
<td>whether to export the RemoteCreatable interface</td>
 
683
</tr>
 
684
</tbody>
 
685
</table></div>
 
686
<p class="since">Since 3.6</p>
 
687
</div>
 
688
<hr>
 
689
<div class="refsect2">
 
690
<a name="e-server-side-source-set-remote-deletable"></a><h3>e_server_side_source_set_remote_deletable ()</h3>
 
691
<pre class="programlisting"><span class="returnvalue">void</span>                e_server_side_source_set_remote_deletable
 
692
                                                        (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
 
693
                                                         <em class="parameter"><code><span class="type">gboolean</span> remote_deletable</code></em>);</pre>
 
694
<p>
 
695
Indicates whether <em class="parameter"><code>source</code></em> can be used to delete resources on a remote
 
696
server.  Typically this is only set to <code class="literal">TRUE</code> for sources created by an
 
697
<a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> to represent a remote resource.
 
698
</p>
 
699
<p>
 
700
If <code class="literal">TRUE</code>, the RemoteDeletable D-Bus interface is exported at the object
 
701
path for <em class="parameter"><code>source</code></em>.  If <code class="literal">FALSE</code>, the RemoteDeletable D-Bus interface is
 
702
unexported at the object path for <em class="parameter"><code>source</code></em>, and any attempt by clients
 
703
to call <code class="function">e_source_remote_delete()</code> will fail.
 
704
</p>
 
705
<p>
 
706
Unlike the <span class="type">"removable"</span> and <span class="type">"writable"</span> properties, this
 
707
is enforced for both clients of the registry D-Bus server and within
 
708
the registry D-Bus service itself.
 
709
</p>
 
710
<div class="variablelist"><table border="0">
 
711
<col align="left" valign="top">
 
712
<tbody>
 
713
<tr>
 
714
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
715
<td>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a>
 
716
</td>
 
717
</tr>
 
718
<tr>
 
719
<td><p><span class="term"><em class="parameter"><code>remote_deletable</code></em> :</span></p></td>
 
720
<td>whether to export the RemoteDeletable interface</td>
 
721
</tr>
 
722
</tbody>
 
723
</table></div>
 
724
<p class="since">Since 3.6</p>
 
725
</div>
644
726
</div>
645
727
<div class="refsect1">
646
728
<a name="EServerSideSource.property-details"></a><h2>Property Details</h2>
665
747
</div>
666
748
<hr>
667
749
<div class="refsect2">
 
750
<a name="EServerSideSource--remote-creatable"></a><h3>The <code class="literal">"remote-creatable"</code> property</h3>
 
751
<pre class="programlisting">  "remote-creatable"         <span class="type">gboolean</span>              : Read / Write</pre>
 
752
<p>Whether the data source can create remote resources.</p>
 
753
<p>Default value: FALSE</p>
 
754
</div>
 
755
<hr>
 
756
<div class="refsect2">
 
757
<a name="EServerSideSource--remote-deletable"></a><h3>The <code class="literal">"remote-deletable"</code> property</h3>
 
758
<pre class="programlisting">  "remote-deletable"         <span class="type">gboolean</span>              : Read / Write</pre>
 
759
<p>Whether the data source can delete remote resources.</p>
 
760
<p>Default value: FALSE</p>
 
761
</div>
 
762
<hr>
 
763
<div class="refsect2">
668
764
<a name="EServerSideSource--removable"></a><h3>The <code class="literal">"removable"</code> property</h3>
669
765
<pre class="programlisting">  "removable"                <span class="type">gboolean</span>              : Read / Write</pre>
670
766
<p>Whether the data source is removable.</p>
678
774
</div>
679
775
<hr>
680
776
<div class="refsect2">
681
 
<a name="EServerSideSource--uid"></a><h3>The <code class="literal">"uid"</code> property</h3>
682
 
<pre class="programlisting">  "uid"                      <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
683
 
<p>The unique identity of the data source.</p>
684
 
<p>Default value: NULL</p>
685
 
</div>
686
 
<hr>
687
 
<div class="refsect2">
688
777
<a name="EServerSideSource--writable"></a><h3>The <code class="literal">"writable"</code> property</h3>
689
778
<pre class="programlisting">  "writable"                 <span class="type">gboolean</span>              : Read / Write</pre>
690
779
<p>Whether the data source is writable.</p>