MyChat Scripts Engine: mSendBroadcast

MyChat Scripts: функция mSendBroadcast, отправка оповещения

Отправить оповещение любому количеству пользователей от имени встроенного робота Elisa (UIN = 0).

 

Синтаксис

function mSendBroadcast(sMsg, sUINsList: string; dtActualTo: double; iStyle: integer): integer;

 

Параметры и возвращаемые значения

Параметр

Тип

Значение

sMsg

string

текст сообщения. Можно использовать переносы строк (CRLF);

sUINsList

string

идентификаторы получателей оповещения через запятую. Текстовая строка;

dtActualTo

double

"срок годности" оповещения. После наступления этого времени оповещение автоматически удаляется и не рассылается тем пользователям, которые не подключились к серверу;

iStyle

integer

тип оповещения:

0 — стандартное;

1 — обязательно к прочтению;

2 — требуется ответ.

 

Результат функции

Результат

Значение

0

всё Ок, оповещение успешно отправлено;

-1

нет списка UIN-ов для оповещения;

-2

неправильный список пользовательских UIN-ов (должны быть только цифры и запятые);

-3

тип оповещения должен быть от 0 до 2;

-5

текст оповещения не может быть пустым.

 

Пример

var
  iResult: integer;
  s: string;
begin
  iResult := mSendBroadcast('Тестовое оповещение из скрипта!', '6', EndOfTheDay(Now), 0);
  
    case iResult of
      0: s := 'Ok';
      -1: s := 'нет списка UIN-ов для оповещения';
      -2: s := 'неправильный список пользовательских UIN-ов (должны быть только цифры и запятые)';
      -3: s := 'тип оповещения должен быть от 0 до 2';
      -4: s := 'текст оповещения не может быть пустым';
    end;
  
  mLogScript('Результат выполнения скрипта: ' + s, '');
end.

 
Результат работы скрипта

[14:51:38] (Log "mSendBroadcast"): Результат выполнения скрипта: Ok

[14:51:38] (Run "mSendBroadcast"): Время выполнения скрипта: 51 мс

[14:51:38] (Run "mSendBroadcast"): Скрипт выполнен успешно.

 

Получение оповещения из скрипта в MyChat Client

 
Ещё посмотреть

EndOfTheDay

mLogScript

Now