1 <?xml version='1.0' encoding='UTF-8'?>
2 <chapter xmlns="http://docbook.org/ns/docbook">
3 <title>Управление сообщениями пользователю</title>
4 <para>В этом разделе собраны вызовы API для отправки сообщений пользователям.</para>
5 <refentry id="stargazer.send_message">
7 <refentrytitle>stargazer.send_message</refentrytitle>
10 <refname>stargazer.send_message</refname>
11 <refpurpose>Отправляет сообщение пользователям</refpurpose>
16 <funcdef><function>stargazer.send_message</function></funcdef>
17 <paramdef>string <parameter>cookie</parameter></paramdef>
18 <paramdef>array of strings <parameter>logins</parameter></paramdef>
19 <paramdef>struct <parameter>info</parameter></paramdef>
24 <title>Description</title>
25 <para>Метод <function>stargazer.send_message</function> отправляет сообщение пользователям, логины которых перечислены в списке.</para>
28 <term>string <parameter>cookie</parameter></term>
30 <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
34 <term>array of strings <parameter>logins</parameter></term>
36 <para>Список логинов пользователей</para>
40 <term>struct <parameter>info</parameter></term>
43 Структура с параметрами сообщения:
46 <term>int <parameter>version</parameter></term>
48 <para>Версия системы сообщений (не обязательный параметр, по умолчанию - 1)</para>
54 <term>int <parameter>type</parameter></term>
56 <para>Тип сообщения (не обязательный параметр, по умолчанию - 1)</para>
62 <term>int <parameter>repeat</parameter></term>
64 <para>Количество показов сообщеня</para>
70 <term>int <parameter>repeat_period</parameter></term>
72 <para>Период повторения показа сообщений (в минутах)</para>
78 <term>int <parameter>show_time</parameter></term>
80 <para>Время отображения сообщения (в секундах)</para>
86 <term>string <parameter>text</parameter></term>
88 <para>Текст сообщения в кодировке CP1251</para>
97 <title>Return Value</title>
98 <para>Возвращает true в случае успеха и false в случае неудачи</para>