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
112
113
114
115
116
117
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2024 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.registerUser">
<refmeta>
<refentrytitle>xmlStorageSystem.registerUser</refentrytitle>
<refmiscinfo>blog</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xmlStorageSystem.registerUser</refname>
<refpurpose>Register a user with the XML Storage System</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xmlStorageSystem.registerUser">
<funcprototype id="fproto_xmlStorageSystem.registerUser">
<funcdef>structure <function>xmlStorageSystem.registerUser</function></funcdef>
<paramdef>in <parameter>email</parameter> string</paramdef>
<paramdef>in <parameter>name</parameter> string</paramdef>
<paramdef>in <parameter>password</parameter> string</paramdef>
<paramdef>in <parameter>clientPort</parameter> integer</paramdef>
<paramdef>in <parameter>userAgent</parameter> string</paramdef>
<paramdef>in <parameter>serialNumber</parameter> string</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_xmlStorageSystem.registerUser">
<title>Description</title>
<para>This method allows users to register within XML Storage System. The actions
performed on the server are:</para>
<simplelist>
<member>make a new Web account named <email> with the password specified.</member>
<member>make a home-folder in WebDAV repository as /DAV/<email>.</member>
<member>make a sub-folder called "blog".</member>
</simplelist>
</refsect1>
<refsect1 id="params_xmlStorageSystem.registerUser"><title>Parameters</title>
<refsect2><title>email</title>
<para>For user identification, this should be a valid email account.</para></refsect2>
<refsect2><title>name</title>
<para>A human readable name for the user account.</para></refsect2>
<refsect2><title>password</title>
<para>The password for authentication. Note that this is the only call that
sends the password in clear-text. All other functions send the password
as a MD5 hash.</para></refsect2>
<refsect2><title>clientPort</title>
<para>Currently ignored and reserved for future use.</para></refsect2>
<refsect2><title>userAgent</title>
<para>Currently ignored and reserved for future use.</para></refsect2>
<refsect2><title>serialNumber</title>
<para>Currently ignored and reserved for future use.</para></refsect2>
</refsect1>
<refsect1 id="ret_xmlStorageSystem.registerUser"><title>Return Types</title>
<para>This method returns a structure as follows:</para>
<programlisting>
'usernum' string account id
'flError' boolean 0 success, 1 fault
'message' string fault message (can be used to handle error cases)
</programlisting>
</refsect1>
<!--
<refsect1 id="errors_xmlStorageSystem.registerUser">
<title>Errors</title>
<para>This function can generate the following errors:</para>
<errorcode></errorcode>
</refsect1>
-->
<refsect1 id="examples_xmlStorageSystem.registerUser">
<title>Examples</title>
<example id="ex_xmlStorageSystem"><title>Registering a new user</title>
<screen>
SQL> SOAP_CLIENT (url=>'http://example.com/xmlStorageSystem',
operation=>'registerUser', parameters=>vector
('email','user@example.domain', 'name', 'Somebody Name',
'password', 'xxx', 'clientPort', 0, 'userAgent', '' , 'serialNumber', ''));
- SOAP response
<registerUserResponse>
<Result>
<usernum>user@example.domain</usernum>
<flError>0</flError>
<message>Welcome, Somebody Name</message>
</Result>
</registerUserResponse>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_xmlStorageSystem.registerUser">
<title>See Also</title>
<para><link linkend="fn_xmlStorageSystem.mailPasswordToUser"><function>xmlStorageSystem.mailPasswordToUser()</function></link></para>
<para><link linkend="fn_xmlStorageSystem.getServerCapabilities"><function>xmlStorageSystem.getServerCapabilities()</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>
|
