-doc suffix removed from XML-RPC API documentation

[stg.git] / doc / xmlrpc / API-messages.xml

diff --git a/doc/xmlrpc/API-messages.xml b/doc/xmlrpc/API-messages.xml
new file mode 100644 (file)
index 0000000..e7b48bc
--- /dev/null
+++ b/doc/xmlrpc/API-messages.xml
@@ -0,0 +1,102 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<chapter xmlns="http://docbook.org/ns/docbook">
+    <title>Управление сообщениями пользователю</title>
+    <para>В этом разделе собраны вызовы API для отправки сообщений пользователям.</para>
+    <refentry id="stargazer.send_user_message">
+        <refmeta>
+            <refentrytitle>stargazer.send_user_message</refentrytitle>
+        </refmeta>
+        <refnamediv>
+            <refname>stargazer.send_user_message</refname>
+            <refpurpose>Отправляет сообщение пользователям</refpurpose>
+        </refnamediv>
+        <refsynopsisdiv>
+            <funcsynopsis>
+                <funcprototype>
+                    <funcdef><function>stargazer.send_user_message</function></funcdef>
+                    <paramdef>string <parameter>cookie</parameter></paramdef>
+                    <paramdef>array of strings <parameter>logins</parameter></paramdef>
+                    <paramdef>struct <parameter>info</parameter></paramdef>
+                </funcprototype>
+            </funcsynopsis>
+        </refsynopsisdiv>
+        <refsect1>
+            <title>Description</title>
+            <para>Метод <function>stargazer.send_user_message</function> отправляет сообщение пользователям, логины которых перечислены в списке.</para>
+            <variablelist>
+                <varlistentry>
+                    <term>string <parameter>cookie</parameter></term>
+                    <listitem>
+                        <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>array of strings <parameter>logins</parameter></term>
+                    <listitem>
+                        <para>Список логинов пользователей</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>struct <parameter>info</parameter></term>
+                    <listitem>
+                        <para>
+                            Структура с параметрами сообщения:
+                            <variablelist>
+                                <varlistentry>
+                                    <term>int <parameter>version</parameter></term>
+                                    <listitem>
+                                        <para>Версия системы сообщений (не обязательный параметр, по умолчанию - 1)</para>
+                                    </listitem>
+                                </varlistentry>
+                            </variablelist>
+                            <variablelist>
+                                <varlistentry>
+                                    <term>int <parameter>type</parameter></term>
+                                    <listitem>
+                                        <para>Тип сообщения (не обязательный параметр, по умолчанию - 1)</para>
+                                    </listitem>
+                                </varlistentry>
+                            </variablelist>
+                            <variablelist>
+                                <varlistentry>
+                                    <term>int <parameter>repeat</parameter></term>
+                                    <listitem>
+                                        <para>Количество показов сообщеня</para>
+                                    </listitem>
+                                </varlistentry>
+                            </variablelist>
+                            <variablelist>
+                                <varlistentry>
+                                    <term>int <parameter>repeat_period</parameter></term>
+                                    <listitem>
+                                        <para>Период повторения показа сообщений (в минутах)</para>
+                                    </listitem>
+                                </varlistentry>
+                            </variablelist>
+                            <variablelist>
+                                <varlistentry>
+                                    <term>int <parameter>show_time</parameter></term>
+                                    <listitem>
+                                        <para>Время отображения сообщения (в секундах)</para>
+                                    </listitem>
+                                </varlistentry>
+                            </variablelist>
+                            <variablelist>
+                                <varlistentry>
+                                    <term>string <parameter>text</parameter></term>
+                                    <listitem>
+                                        <para>Текст сообщения в кодировке UTF-8</para>
+                                    </listitem>
+                                </varlistentry>
+                            </variablelist>
+                        </para>
+                    </listitem>
+                </varlistentry>
+            </variablelist>
+            <refsect2>
+                <title>Return Value</title>
+                <para>Возвращает true в случае успеха и false в случае неудачи</para>
+            </refsect2>
+        </refsect1>
+    </refentry>
+</chapter>