1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<!-- Created with Funcmake.vsp -->
<refentry id="fn_xmlStorageSystem.getServerCapabilities">
<refmeta>
<refentrytitle>xmlStorageSystem.getServerCapabilities</refentrytitle>
<refmiscinfo>blog</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xmlStorageSystem.getServerCapabilities</refname>
<refpurpose>Retrieve server specific information.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xmlStorageSystem.getServerCapabilities">
<funcprototype id="fproto_xmlStorageSystem.getServerCapabilities">
<funcdef>structure <function>xmlStorageSystem.getServerCapabilities</function></funcdef>
<paramdef>in <parameter>email</parameter> string</paramdef>
<paramdef>in <parameter>password</parameter> string</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_xmlStorageSystem.getServerCapabilities">
<title>Description</title>
<para>This method is used to obtain information about the capabilities of the server, such as
files size limitations, supported types, etc...</para>
</refsect1>
<refsect1 id="params_xmlStorageSystem.getServerCapabilities"><title>Parameters</title>
<refsect2><title>email</title>
<para>For user identification, this should be a valid email account.</para></refsect2>
<refsect2><title>password</title>
<para>The MD5 hash of the password.</para></refsect2>
</refsect1>
<refsect1 id="ret_xmlStorageSystem.getServerCapabilities"><title>Return Types</title>
<para>This method returns a structure as follows:</para>
<programlisting>
'flError' boolean 0 success, 1 fault
'message' string fault message (can be used to handle error cases)
ctBytesInUse integer how many bytes are used on repository
legalFileExtensions string array which extensions are recognized
maxBytesPerUser integer total bytes available for this user
maxFileSize integer largest file size for upload (bytes)
yourUpstreamFolderUrl string base URL for user's blog on repository
</programlisting>
</refsect1>
<!--
<refsect1 id="errors_xmlStorageSystem.getServerCapabilities">
<title>Errors</title>
<para>This function can generate the following errors:</para>
<errorcode></errorcode>
</refsect1>
-->
<refsect1 id="examples_xmlStorageSystem.getServerCapabilities">
<title>Examples</title>
<example id="ex_XMLStorageSystem.getServerCapabilities"><title>Retrieving the XML Storage System Capabilities</title>
<para>Simple example of fetching the server capabilities.</para>
<screen>
SQL> SOAP_CLIENT (url=>'http://example.com/xmlStorageSystem',
operation=>'getServerCapabilities', parameters=>vector
('email','user@example.domain', 'password', md5('xxx'));
SOAP response:
<getServerCapabilitiesResponse>
<Result>
<ctBytesInUse>14</ctBytesInUse>
<flError>0</flError>
<legalFileExtensions>
<item>ai</item>
<item>aif</item>
<item>aifc</item>
</legalFileExtensions>
<maxBytesPerUser>41943040</maxBytesPerUser>
<maxFileSize>1048576</maxFileSize>
<message />
<yourUpstreamFolderUrl>http://example.com/DAV/user@example.domain/blog/</yourUpstreamFolderUrl>
</Result>
</getServerCapabilitiesResponse>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_xmlStorageSystem.getServerCapabilities">
<title>See Also</title>
<para><link linkend="fn_xmlStorageSystem.registerUser"><function>xmlStorageSystem.registerUser()</function></link></para>
<para><link linkend="fn_xmlStorageSystem.mailPasswordToUser"><function>xmlStorageSystem.mailPasswordToUser()</function></link></para>
<para><link linkend="fn_xmlStorageSystem.deleteMultipleFiles"><function>xmlStorageSystem.deleteMultipleFiles()</function></link></para>
<para><link linkend="fn_xmlStorageSystem.saveMultipleFiles"><function>xmlStorageSystem.saveMultipleFiles()</function></link></para>
</refsect1>
</refentry>
|
