File: blogger.getUserInfo.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (100 lines) | stat: -rw-r--r-- 4,098 bytes parent folder | download | duplicates (2)
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
<?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
 -  
 -  
-->
<refentry id="fn_blogger.getUserInfo">
  <refmeta>
    <refentrytitle>blogger.getUserInfo</refentrytitle>
    <refmiscinfo>blog</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>blogger.getUserInfo</refname>
    <refpurpose>Returns information about a blog author.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_blogger.getUserInfo">
      <funcprototype id="fproto_blogger.getUserInfo">
        <funcdef>string <function>blogger.getUserInfo</function></funcdef>
        <paramdef>in <parameter>appkey</parameter> string</paramdef>
        <paramdef>in <parameter>username</parameter> string</paramdef>
        <paramdef>in <parameter>password</parameter> string</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_blogger.getUserInfo">
    <title>Description</title>
    <para>This function retrieves information about a blog author.</para>
  </refsect1>
  <refsect1 id="params_blogger.getUserInfo"><title>Parameters</title>
    <refsect2><title>appkey</title>
      <para>an identity string unique identifying the application that was
used to create the posting.  This is currently ignored by the Virtuoso server; 
it can be used with custom application logic to process specific 
application requests separately.</para></refsect2>
    <refsect2><title>username</title>
      <para>name of user to be authenticated.</para></refsect2>
    <refsect2><title>password</title>
      <para>password for username.</para></refsect2>
  </refsect1>
  <refsect1 id="ret_blogger.getUserInfo"><title>Return Types</title>
    <para>Upon success this will return a struct containing:</para>
<programlisting>
{ 
  string userid
  string firstname
  string lastname
  string nickname
  string email
  string url
}
</programlisting>
<para>Upon failure, the fault will be returned.</para>
  </refsect1>
<!--
  <refsect1 id="errors_blogger.getUserInfo">
    <title>Errors</title>
    <para>This function can generate the following errors:</para>
    <errorcode></errorcode>
  </refsect1>
  <refsect1 id="examples_blogger.getUserInfo">
    <title>Examples</title>
    <example id="ex_"><title />
      <para />
      <screen>

</screen>
    </example>
  </refsect1>
-->
  <refsect1 id="seealso_blogger.getUserInfo">
    <title>See Also</title>
      <para><link linkend="fn_blogger.newPost"><function>blogger.newPost()</function></link></para>
      <para><link linkend="fn_blogger.editPost"><function>blogger.editPost()</function></link></para>
      <para><link linkend="fn_blogger.deletePost"><function>blogger.deletePost()</function></link></para>
      <para><link linkend="fn_blogger.getRecentPosts"><function>blogger.getRecentPosts()</function></link></para>
      <para><link linkend="fn_blogger.getUsersBlogs"><function>blogger.getUsersBlogs()</function></link></para>
      <para><link linkend="fn_blogger.getTemplate"><function>blogger.getTemplate()</function></link></para>
      <para><link linkend="fn_blogger.setTemplate"><function>blogger.setTemplate()</function></link></para>
      <para><link linkend="fn_blogger.getUserInfo"><function>blogger.getUserInfo()</function></link></para>
  </refsect1>
</refentry>