Модуль управления оповещениями УХ

ПолучитьСлужебнуюЧастьПисьмаЗадачи

Описание, пример вызова

// Возвращает уникальную служебную часть, которая будет добавлена к письму с задачей
Функция ПолучитьСлужебнуюЧастьПисьмаЗадачи() Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьСлужебнуюЧастьПисьмаЗадачи()

СоздатьЗаписьОтправленныеЗадачи

Описание, пример вызова

// Создает запись в регистре Отправленные задачи по параметрам. Возвращает ИдентификаторСообщения. Когда
//ИдентификаторСообщенияВход не задан - будет сгенерирован новый.
Функция СоздатьЗаписьОтправленныеЗадачи(ЗадачаВход, ПользовательВход, ИдентификаторСообщенияВход = Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.СоздатьЗаписьОтправленныеЗадачи(ЗадачаВход, ПользовательВход, ИдентификаторСообщенияВход);

ПолучитьСтруктуруПоИдентификаторуСообщения

Описание, пример вызова

// По идентификатору сообщения ИдентификаторВход возвращает структуру из регистра ОтправленныеЗадачи.
Функция ПолучитьСтруктуруПоИдентификаторуСообщения(ИдентификаторВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьСтруктуруПоИдентификаторуСообщения(ИдентификаторВход)

УстановитьИсполнениеОтправленнойЗадачи

Описание, пример вызова

// Устанавливает по ИдентификаторСообщенияВход в регистре ОтправленныеЗадачи флаг исполнения в
//значение ЗначениеИсполненияВход.
Процедура УстановитьИсполнениеОтправленнойЗадачи(ИдентификаторСообщенияВход, ЗначениеИсполненияВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.УстановитьИсполнениеОтправленнойЗадачи(ИдентификаторСообщенияВход, ЗначениеИсполненияВход)

УстановитьСтатусОшибкиОтправленнойЗадачи

Описание, пример вызова

// Устанавливает по ИдентификаторСообщенияВход в регистре ОтправленныеЗадачи флаг Ошибка в
//значение ЗначениеИсполненияВход.
Процедура УстановитьСтатусОшибкиОтправленнойЗадачи(ИдентификаторСообщенияВход, ЗначениеСтатусаОшибкиВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.УстановитьСтатусОшибкиОтправленнойЗадачи(ИдентификаторСообщенияВход, ЗначениеСтатусаОшибкиВход)

ПолучитьКонстантуНавигационнаяСсылкаИнформационнойБазы

Описание, пример вызова

// Возвращает значение константы НавигационнаяСсылкаИнформационнойБазы
Функция ПолучитьКонстантуНавигационнаяСсылкаИнформационнойБазы() Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьКонстантуНавигационнаяСсылкаИнформационнойБазы()

ПреобразоватьНавигационныеСсылкиВоВнешние

Описание, пример вызова

// Заменяет все навигационные ссылки, содержащиеся в ИсходныйТекстВход, на внешние.
Функция ПреобразоватьНавигационныеСсылкиВоВнешние(ИсходныйТекстВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПреобразоватьНавигационныеСсылкиВоВнешние(ИсходныйТекстВход)

СоздатьОповещениеПользователю

Описание, пример вызова

Процедура СоздатьОповещениеПользователю(КатегорияОповещения,ВидСобытия,Пользователь,ТекстСообщения, ЗадачаВход = Неопределено, ТекстПочтовогоСообщения = "",Вложение = Неопределено) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.СоздатьОповещениеПользователю(КатегорияОповещения, ВидСобытия, Пользователь, ТекстСообщения, ЗадачаВход, ТекстПочтовогоСообщения, Вложение);

УчетнаяЗаписьДляРассылкиУведомлений

Описание, пример вызова

Функция УчетнаяЗаписьДляРассылкиУведомлений() Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.УчетнаяЗаписьДляРассылкиУведомлений()

ПолучитьЗначениеРеквизитаСсылки

Описание, пример вызова

// Возвращает значение реквизита с именем ПараметрВход объекта СсылкаВход с именем ИмяСсылкиВход.
Функция ПолучитьЗначениеРеквизитаСсылки(ОбъектСсылкаВход, ИмяСсылкиВход, ПараметрВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьЗначениеРеквизитаСсылки(ОбъектСсылкаВход, ИмяСсылкиВход, ПараметрВход));

ПолучитьПредставлениеПараметраШаблона

Описание, пример вызова

// Возвращает представление реквизита ИмяПараметраВход со значением ЗначениеПараметраВход для
// объекта ОбъектСсылкаВход.
Функция ПолучитьПредставлениеПараметраШаблона(ОбъектСсылкаВход, ИмяПараметраВход, ЗначениеПараметраВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьПредставлениеПараметраШаблона(ОбъектСсылкаВход, ИмяПараметраВход, ЗначениеПараметраВход));

ОбработатьПараметрШаблона

Описание, пример вызова

// Выполняет обработку параметров, обозначенных через СлужебноеИмяВход. Возвращает структуру со значением и именем параметра
Функция ОбработатьПараметрШаблона(СлужебноеИмяВход, ПараметрыПроцессаВход, ОбъектСсылкаВход, ФлОшибкиВход, ТекстШаблонаРабочийВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ОбработатьПараметрШаблона(СлужебноеИмяВход, ПараметрыПроцессаВход, ОбъектСсылкаВход, ФлОшибкиВход, ТекстШаблонаРабочийВход));

ПодготовитьТекстОповещенияПоШаблону

Описание, пример вызова

Функция ПодготовитьТекстОповещенияПоШаблону(ТекстШаблона,ПараметрыПроцесса=Неопределено,ОбъектССылка,ФлОшибки=Ложь) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПодготовитьТекстОповещенияПоШаблону(ТекстШаблона, ПараметрыПроцесса, ОбъектССылка, ФлОшибки);

ПолучитьМассивПользователейПоЗадаче

Описание, пример вызова

// Возвращает массив активных ответственных по задаче ЗадачаВход.
Функция ПолучитьМассивПользователейПоЗадаче(ЗадачаВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьМассивПользователейПоЗадаче(ЗадачаВход));

СоздатьСобытиеОповещения

Описание, пример вызова

// Создаёт запись в регистре СобытияОповещений по переданным параметрам в структуре Параметры.
Процедура СоздатьСобытиеОповещения(Параметры) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.СоздатьСобытиеОповещения(Параметры));

ОповеститьПользователей

Описание, пример вызова

// Создаёт событие оповещения
//
// Параметры:
//  ВидСобытия - Вид события оповещения;
//  ШаблонОповещения - Шаблон, который будет заполнен в оповещении. Если не указан - будет использоваться из настроек оповещения;
//  ИсточникСсылка - Ссылка на ключевой объект оповещения. Если не указан - будет использоваться объект оповещения, назначенный категории оповещения;
//  СписокРассылки - Список пользователей, которым будет отправлено оповещение. Если не указан - будет использоваться пользователь, назначенный категорией оповещения;
//  ДопПараметры - Структура дополнительных параметров, подставляемых в шаблон;
//  ЗадачаВход - Задача, которая будет привязана к данному оповещению. Если не указано - оповещение будет создано без привязки к задаче;
//  ЭтапПроцессаВход - Этап процесса (если требуется), на котором произошло данное событие.
Функция ОповеститьПользователей(ВидСобытия, ШаблонОповещения = Неопределено, ИсточникСсылка = Неопределено, СписокРассылки = Неопределено, ДопПараметры = Неопределено, ЗадачаВход = Неопределено, ЭтапПроцессаВход = Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ОповеститьПользователей(ВидСобытия, ШаблонОповещения, ИсточникСсылка, СписокРассылки, ДопПараметры, ЗадачаВход, ЭтапПроцессаВход);

СоздатьНапоминание

Описание, пример вызова

// Создаёт напоминание
//
// Параметры:
//  ВидСобытия - вид события оповещения;
//  ИсточникСсылка - ссылка на ключевой объект напоминания;
//  СписокРассылки - список пользователей, которым будет отправлено напоминание;
Функция СоздатьНапоминание(ВидСобытия, ИсточникСсылка, СписокРассылки, ТекущийДокументПроцесса = Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.СоздатьНапоминание(ВидСобытия, ИсточникСсылка, СписокРассылки, ТекущийДокументПроцесса);

ПолучитьТипОбъектаОповещенияПоСсылке

Описание, пример вызова

// Возвращает ссылку на элементы справочника Справочник БД/Документ БД,
// который соответствует принадлежности ссылки СсылкаВход.
Функция ПолучитьТипОбъектаОповещенияПоСсылке(ИсточникСсылкаВходПараметр) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьТипОбъектаОповещенияПоСсылке(ИсточникСсылкаВходПараметр)

ПолучитьТаблицуШаблоновПоПараметрамРассылки

Описание, пример вызова

// Возвращает таблицу значений, содержащую шаблоны оповещений и получателей
// по объекту ИсточникСсылкаВход и событию ВидСобытияВход
Функция ПолучитьТаблицуШаблоновПоПараметрамРассылки(ВидСобытияВход, ИсточникСсылкаВход, ТипОбъектаОповещения) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьТаблицуШаблоновПоПараметрамРассылки(ВидСобытияВход, ИсточникСсылкаВход, ТипОбъектаОповещения)

ПолучитьТекстСообщенияПоШаблону

Описание, пример вызова

// Возвращает текст сообщения по событию ВидСобытияВход и ИсточникСсылкаВход. Когда категория не задана -
// будет вычислена из Вида события. Сначала используется шаблон ШаблонОповещения, после ШаблонПоУмолчанию,
// в случае отсутствия обоих - берется шаблон из кода.
Функция ПолучитьТекстСообщенияПоШаблону(ВидСобытияВход, ИсточникСсылкаВход, КатегорияСобытияВход = Неопределено, ШаблонОповещения = Неопределено, ШаблонПоУмолчанию = Неопределено, ДопПараметрыВход = Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьТекстСообщенияПоШаблону(ВидСобытияВход, ИсточникСсылкаВход, КатегорияСобытияВход, ШаблонОповещения, ШаблонПоУмолчанию, ДопПараметрыВход);

ДобавитьТекстЗамещения

Описание, пример вызова

// Возвращает текст сообщения, в которое добавлена информация
// о замещении пользователя ЗамещаемыйВход.
Функция ДобавитьТекстЗамещения(СообщениеВход, ЗамещаемыйВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ДобавитьТекстЗамещения(СообщениеВход, ЗамещаемыйВход)

ПользовательПолучилОповещениеОЗадаче

Описание, пример вызова

// Определяет, получил ли пользователь оповещение по данной задаче ранее.
Функция ПользовательПолучилОповещениеОЗадаче(ПолучательВход, ЗадачаВход, ВидСобытияВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПользовательПолучилОповещениеОЗадаче(ПолучательВход, ЗадачаВход, ВидСобытияВход));

ДобавитьДопПараметрВТаблицу

Описание, пример вызова

// Добавляет в таблицу дополнительных параметров ТаблицаДопПараметров значение ЗначениеПараметраВход
// параметра с кодом КодПараметраВход. Когда ТаблицаДопПараметров - неопределено, формирует новую.
Процедура ДобавитьДопПараметрВТаблицу(ТаблицаДопПараметров, КодПараметраВход, ЗначениеПараметраВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ДобавитьДопПараметрВТаблицу(ТаблицаДопПараметров, КодПараметраВход, ЗначениеПараметраВход)

ОповеститьПользователейВФоне

Описание, пример вызова

Процедура ОповеститьПользователейВФоне(Параметры, АдресХранилища, АдресХранилищаДополнительный) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ОповеститьПользователейВФоне(Параметры, АдресХранилища, АдресХранилищаДополнительный)

ПолучитьТекстПоВидуСобытияПоШаблону

Описание, пример вызова

// Возвращает текст оповещения по настройкам шаблонов для события ВидСобытияВход по
// объекту ИсточникСсылкаВход.
Функция ПолучитьТекстПоВидуСобытияПоШаблону(ВидСобытияВход, ИсточникСсылкаВход, ДопПараметрыВход = Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьТекстПоВидуСобытияПоШаблону(ВидСобытияВход, ИсточникСсылкаВход, ДопПараметрыВход);

ПреобразоватьСтруктуруДопПараметровОповещения

Описание, пример вызова

// Преобразует структуру дополнительных параметров оповещения в таблицу для передачи в
// программный интерфейс заполнения шаблона.
Функция ПреобразоватьСтруктуруДопПараметровОповещения(СтруктураВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПреобразоватьСтруктуруДопПараметровОповещения(СтруктураВход)

ПолучитьПустоеЗначениеСправочникаБД

Описание, пример вызова

// Возвращает пустое значение по данным справочника (Справочник БД, Документ БД).
Функция ПолучитьПустоеЗначениеСправочникаБД(СправочникБДВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьПустоеЗначениеСправочникаБД(СправочникБДВход)

ПолучитьПоставляемыеДанныеПоВидуСобытия

Описание, пример вызова

// Возвращает структуру, содержащую данные поставляемого макета по виду события
// ВидСобытияВход и категории КатегорияВход.
Функция ПолучитьПоставляемыеДанныеПоВидуСобытия(ВидСобытияВход, КатегорияВход = Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьПоставляемыеДанныеПоВидуСобытия(ВидСобытияВход, КатегорияВход);

ПолучитьТекстОповещенияПоВидуСобытияПоУмолчанию

Описание, пример вызова

Функция ПолучитьТекстОповещенияПоВидуСобытияПоУмолчанию(КатегорияСобытия, ВидСобытия, ИсточникСсылка) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьТекстОповещенияПоВидуСобытияПоУмолчанию(КатегорияСобытия, ВидСобытия, ИсточникСсылка)

ПолучитьОповещаемыхПоУмолчанию

Описание, пример вызова

Функция ПолучитьОповещаемыхПоУмолчанию(КатегорияСобытия,ВидСобытия,ИсточникСсылка,ИсходныйСписокРассылки) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьОповещаемыхПоУмолчанию(КатегорияСобытия, ВидСобытия, ИсточникСсылка, ИсходныйСписокРассылки));

ДобавитьЗаместителейПользователей

Описание, пример вызова

// Возвращает копию ТаблицаВход, дополненную заместителями
// пользователей, а также колонкой с замещаемыми пользователями.
Функция ДобавитьЗаместителейПользователей(ТаблицаВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ДобавитьЗаместителейПользователей(ТаблицаВход));

ПолучитьОповещаемыхПоСпискуРассылки

Описание, пример вызова

Функция ПолучитьОповещаемыхПоСпискуРассылки(СписокРассылки,ИсточникСсылка,ТипОбъектаОповещения,ИсходныйСписокРассылки) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьОповещаемыхПоСпискуРассылки(СписокРассылки, ИсточникСсылка, ТипОбъектаОповещения, ИсходныйСписокРассылки));

ОповеститьПользователейПоНаборуЗаписей

Описание, пример вызова

Процедура ОповеститьПользователейПоНаборуЗаписей(НаборЗаписей) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ОповеститьПользователейПоНаборуЗаписей(НаборЗаписей)

ВернутьСписокОповещаемыхПоЭтапуПодготовкиОтчетности

Описание, пример вызова

Функция ВернутьСписокОповещаемыхПоЭтапуПодготовкиОтчетности(Этап,ВерсияОрганизационнойСтруктуры,Организация=Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ВернутьСписокОповещаемыхПоЭтапуПодготовкиОтчетности(Этап, ВерсияОрганизационнойСтруктуры, Организация);

ПолучитьОграниченияТипаДляВидаОбъектаОповещения

Описание, пример вызова

// Возвращает ограничение типа для выбора вида объекта оповещения по категории
// КатегорияВход, событию ВидСобытияВход и типу объекта ТипОбъектаВход.
Функция ПолучитьОграниченияТипаДляВидаОбъектаОповещения(КатегорияВход, ВидСобытияВход, ТипОбъектаВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьОграниченияТипаДляВидаОбъектаОповещения(КатегорияВход, ВидСобытияВход, ТипОбъектаВход)

ПолучитьЗначениеПараметраПоПолномуИмени

Описание, пример вызова

//Функция получает значение параметра оповещения по полному имени
//
Функция ПолучитьЗначениеПараметраПоПолномуИмени(ОбъектСсылкаВход, ИмяПараметра) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьЗначениеПараметраПоПолномуИмени(ОбъектСсылкаВход, ИмяПараметра));

ВернутьОбъектШаблона

Описание, пример вызова

Функция ВернутьОбъектШаблона(ТипОбъектаОповещения,НазначениеОповещения) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ВернутьОбъектШаблона(ТипОбъектаОповещения, НазначениеОповещения)

ДобавитьСтандартныеРеквизитыВСхему

Описание, пример вызова

// Добавляет в схему скд МакетСкд ревизитов объекта ТипОбъектаОповещенияВход его
// стандартные реквизиты.
Процедура ДобавитьСтандартныеРеквизитыВСхему(ТипОбъектаОповещенияВход, МакетСкд) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ДобавитьСтандартныеРеквизитыВСхему(ТипОбъектаОповещенияВход, МакетСкд));

ЭтоПредставлениеПримитивногоТипа

Описание, пример вызова

// Определяет, принадлежит ли представление типа ПредставлениеВход примитивному типу.
Функция ЭтоПредставлениеПримитивногоТипа(ПредставлениеВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ЭтоПредставлениеПримитивногоТипа(ПредставлениеВход));

ПолучитьСхемуСКДДляПодстановкиВШаблоне

Описание, пример вызова

Функция ПолучитьСхемуСКДДляПодстановкиВШаблоне(ТипОбъектаОповещения, ВидОбъектаОповещения, НазначениеОповещения, ВидСобытияВход = Неопределено, ОграничиватьСсылочныеВход = Ложь) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьСхемуСКДДляПодстановкиВШаблоне(ТипОбъектаОповещения, ВидОбъектаОповещения, НазначениеОповещения, ВидСобытияВход, ОграничиватьСсылочныеВход);

ЗаполнитьСхемуСКДДляПодстановкиВШаблоне

Описание, пример вызова

Процедура ЗаполнитьСхемуСКДДляПодстановкиВШаблоне(ТипОбъектаОповещенияВход, ВидОбъектаОповещенияВход, НазначениеОповещенияВход, ВыходноеЗначение) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ЗаполнитьСхемуСКДДляПодстановкиВШаблоне(ТипОбъектаОповещенияВход, ВидОбъектаОповещенияВход, НазначениеОповещенияВход, ВыходноеЗначение)

ДобавитьОписаниеПоляСКД

Описание, пример вызова

Процедура ДобавитьОписаниеПоляСКД(ИмяПоля,СинонимПоля,ТипДанных,МакетСкд, ТипОбъектаОповещения = Неопределено) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ДобавитьОписаниеПоляСКД(ИмяПоля, СинонимПоля, ТипДанных, МакетСкд, ТипОбъектаОповещения);

ПолучитьПредставлениеПараметра

Описание, пример вызова

Функция ПолучитьПредставлениеПараметра(СтрПараметр) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьПредставлениеПараметра(СтрПараметр));

ЗаполнитьНастройкиОповещений

Описание, пример вызова

//Процедура вызывается для заполнения предопределенных элементов категорий оповещений и видов событий оповещений
Процедура ЗаполнитьНастройкиОповещений() Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ЗаполнитьНастройкиОповещений()

ПолучитьТипОбъектаПоВидуОповещения

Описание, пример вызова

// Возвращает тип объекта оповещения, ассоциировнный с видом события ВидСобытияВход.
// Когда невозможно однозначно определить тип объекта - возвращает Неопределено.
Функция ПолучитьТипОбъектаПоВидуОповещения(ВидСобытияВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьТипОбъектаПоВидуОповещения(ВидСобытияВход)

ДобавитьНапоминаниеПользователя

Описание, пример вызова

// Добавляет напоминание по ПользовательВход, ВремяСобытияВход, ИсточникВход,
// ВидСобытияОповещенияВход с указанными параметрами.
Процедура ДобавитьНапоминаниеПользователя(ПользовательВход, ВремяСобытияВход, ИсточникВход, ВидСобытияОповещенияВход, СрокНапоминанияВход, ИнтервалВремениНапоминанияВход = 0, ВремяПоследнегоНапоминанияВход = Неопределено, ОписаниеВход = "", ЗадачаВход = Неопределено, ДопПараметрыВход = Неопределено) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ДобавитьНапоминаниеПользователя(ПользовательВход, ВремяСобытияВход, ИсточникВход, ВидСобытияОповещенияВход, СрокНапоминанияВход, ИнтервалВремениНапоминанияВход, ВремяПоследнегоНапоминанияВход, ОписаниеВход, ЗадачаВход, ДопПараметрыВход);

ДобавитьНапоминаниеПользователяСЗадачей

Описание, пример вызова

// Добавляет напоминание пользователю и задачу, где необходимые параметры заданы в виде
// структуры СтруктураВход.
Процедура ДобавитьНапоминаниеПользователяСЗадачей(СтруктураВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ДобавитьНапоминаниеПользователяСЗадачей(СтруктураВход)

ДобавитьНапоминаниеПользователяПоСтруктуре

Описание, пример вызова

// Добавляет напоминание пользователю, где необходимые параметры заданы в виде Структуры
//
// Параметры:
//  СтруктураВход   - см. МодульУправленияОповещениямиУХ.СтруктураНапоминания
//
Процедура ДобавитьНапоминаниеПользователяПоСтруктуре(СтруктураВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ДобавитьНапоминаниеПользователяПоСтруктуре(СтруктураВход)

СтруктураНапоминания

Описание, пример вызова

// Функция - Структура для создания напоминания см. МодульУправленияОповещениямиУХ.ДобавитьНапоминаниеПользователяПоСтруктуре
//
// Возвращаемое значение:
//   - Структура
//
Функция СтруктураНапоминания() Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.СтруктураНапоминания()

ПолучитьТаблицуНаступившихСобытий

Описание, пример вызова

// Возвращает таблицу напоминаний, которые уже наступили на дату ДатаВход.
// Когда ДатаВход не указана - будет использована текущая.
Функция ПолучитьТаблицуНаступившихСобытий(ДатаВход = Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьТаблицуНаступившихСобытий(ДатаВход);

ПолучитьТаблицуАктуальныхНапоминанийПользователя

Описание, пример вызова

// Возвращает таблицу напоминаний актуальных для пользователя ПользовательВход на дату ДатаВход.
// Когда ДатаВход не указана, берётся текущая.
Функция ПолучитьТаблицуАктуальныхНапоминанийПользователя(ПользовательВход, ДатаВход = Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьТаблицуАктуальныхНапоминанийПользователя(ПользовательВход, ДатаВход);

ПеренестиНапоминание

Описание, пример вызова

// Осуществляет перенос напоминания по параметрам ПользовательВход, ВремяСобытияВход, ИсточникВход, ВидСобытияОповещенияВход
// на новое время НоваяДатаОповещенияВход. Когда параметр ЗафиксироватьПереносВход - Истина, будет также записано время переноса.
// Возвращает успешность выполнения операции.
Функция ПеренестиНапоминание(ПользовательВход, ВремяСобытияВход, ИсточникВход, ВидСобытияОповещенияВход, НоваяДатаОповещенияВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПеренестиНапоминание(ПользовательВход, ВремяСобытияВход, ИсточникВход, ВидСобытияОповещенияВход, НоваяДатаОповещенияВход)

ОтключитьНапоминание

Описание, пример вызова

// Выполняет отключение напоминания пользователя по переданным параметрам. Возвращает успешность выполнения операции.
Функция ОтключитьНапоминание(ПользовательВход, ВремяСобытияВход, ИсточникВход, ВидСобытияОповещенияВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ОтключитьНапоминание(ПользовательВход, ВремяСобытияВход, ИсточникВход, ВидСобытияОповещенияВход)

УдалитьНапоминание

Описание, пример вызова

// Удаляет из регистра напоминание по переданным параметрам.
Процедура УдалитьНапоминание(ПользовательВход, ВремяСобытияВход, ИсточникВход, ВидСобытияОповещенияВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.УдалитьНапоминание(ПользовательВход, ВремяСобытияВход, ИсточникВход, ВидСобытияОповещенияВход)

УдалитьНапоминанияПоОтбору

Описание, пример вызова

// Удаляет из регистра напоминание по переданным параметрам.
//
// Параметры:
//  ПараметрыОтбора   - Структура - параметры отбора напоминаний по измерениям регистра НапоминанияПользователяУХ
//
Процедура УдалитьНапоминанияПоОтбору(ПараметрыОтбора) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.УдалитьНапоминанияПоОтбору(ПараметрыОтбора)

УдалитьНапоминанияПоИсточнику

Описание, пример вызова

// Процедура - Удаляет напоминания по источнику
//
// Параметры:
//  Источник - см. РегистрСведений.НапоминанияПользователяУХ.Источник
//
Процедура УдалитьНапоминанияПоИсточнику(Источник) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.УдалитьНапоминанияПоИсточнику(Источник)

ОбновитьОповещенияПоНапоминаниям

Описание, пример вызова

// Проверяет наличие оповещения по задаче ЗадачаВход. В случае отсуствия - создаёт новое оповещение с переданными
// параметрами. Иначе - обновляет дату создания и сбрасывает флаг прочтения у оповещения.
Процедура ОбновитьОповещенияПоНапоминаниям(ПользовательВход, ИсточникВход, ВидСобытияОповещенияВход, ЗадачаВход, ДопПараметрыВход = Неопределено) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ОбновитьОповещенияПоНапоминаниям(ПользовательВход, ИсточникВход, ВидСобытияОповещенияВход, ЗадачаВход, ДопПараметрыВход);

ОбработатьТаблицуНапоминанийСобытий

Описание, пример вызова

// Осуществляет рассылку оповещений и перенос напоминаний по таблице
// событий ТаблицаСобытийВход
Процедура ОбработатьТаблицуНапоминанийСобытий(ТаблицаСобытийВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ОбработатьТаблицуНапоминанийСобытий(ТаблицаСобытийВход));

ОбработатьНапоминанияПользователей

Описание, пример вызова

// Осуществляет обработку напоминаний пользователей и отправку по ним оповещений при необходимости
Процедура ОбработатьНапоминанияПользователей() Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ОбработатьНапоминанияПользователей()

ПолучитьИнтервалДоБлижайшегоНапоминанияПользователя

Описание, пример вызова

// Получает время (в секундах) до ближайшего напоминания пользователю ПользовательВход
Функция ПолучитьИнтервалДоБлижайшегоНапоминанияПользователя(ПользовательВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьИнтервалДоБлижайшегоНапоминанияПользователя(ПользовательВход));

ОбработатьНапоминанияТекущегоПользователя

Описание, пример вызова

// Осуществляет поиск наступивших напоминаний пользователя. Возвращает
// структуру, содержащую массив напоминаний и интервал до ближайшего
// следующего напоминания
Функция ОбработатьНапоминанияТекущегоПользователя() Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ОбработатьНапоминанияТекущегоПользователя()

СоздатьСтруктуруНапоминанияПоУмолчанию

Описание, пример вызова

// Создаёт структуру напоминания с настройками СтруктураНастроекВход по
// событию оповещения для отправки пользователю ПользовательВход напоминания
// о событии в дату ВремяСобытияВход по объекту напоминания ИстиочникСобытияВход.
// ВАЖНО! Ссылка на задачу по умолчанию не включается в структуру.
Функция СоздатьСтруктуруНапоминанияПоУмолчанию(СтруктураНастроекВход, ПользовательВход, ВремяСобытияВход, ИсточникСобытияВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.СоздатьСтруктуруНапоминанияПоУмолчанию(СтруктураНастроекВход, ПользовательВход, ВремяСобытияВход, ИсточникСобытияВход)

ПолучитьНастройкиОповещенийПоВидуСобытия

Описание, пример вызова

// По виду события ВидСобытияВход возвращает структуру настроек оповещения
Функция ПолучитьНастройкиОповещенийПоВидуСобытия(ВидСобытияВход, ВидОбъектаВход = Неопределено) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьНастройкиОповещенийПоВидуСобытия(ВидСобытияВход, ВидОбъектаВход);

ПолучитьНастройкиОповещенийПоВидуСобытияИТипуОбъекта

Описание, пример вызова

// По виду события ВидСобытияВход и типу объекта ТипОбъектаВход возвращает структуру настроек оповещения
Функция ПолучитьНастройкиОповещенийПоВидуСобытияИТипуОбъекта(ВидСобытияВход, ТипОбъектаВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ПолучитьНастройкиОповещенийПоВидуСобытияИТипуОбъекта(ВидСобытияВход, ТипОбъектаВход)

ВключеноОповещениеПоВидуСобытия

Описание, пример вызова

// Возвращает состояние включения оповещения по виду события ВидСобытияВход.
Функция ВключеноОповещениеПоВидуСобытия(ВидСобытияВход) Экспорт

Пример вызова

Результат = МодульУправленияОповещениямиУХ.ВключеноОповещениеПоВидуСобытия(ВидСобытияВход)

УдалитьНапоминанияПользователей

Описание, пример вызова

// Снимает напоминание пользователям из МассивОповещаемыхВход по заданным параметрам.
Процедура УдалитьНапоминанияПользователей(ИсточникВход, ВидСобытияВход, МассивОповещаемыхВход, ДатаВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.УдалитьНапоминанияПользователей(ИсточникВход, ВидСобытияВход, МассивОповещаемыхВход, ДатаВход)

СоздатьНапоминаниеПоЛоту

Описание, пример вызова

// Создает напоминание пользователям из массива МассивОповещаемыхВход по лоту ЛотВход
// по виду события ВидСобытияВход на дату ДатаВход.
Процедура СоздатьНапоминаниеПоЛоту(ЛотВход, ВидСобытияВход, МассивОповещаемыхВход, ДатаВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.СоздатьНапоминаниеПоЛоту(ЛотВход, ВидСобытияВход, МассивОповещаемыхВход, ДатаВход)

УдалитьНапоминанияПоДоговорам

Описание, пример вызова

// Удаляет из регистра напоминания об оплате по договорам из массива МассивДоговоровВход.
Процедура УдалитьНапоминанияПоДоговорам(МассивДоговоровВход) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.УдалитьНапоминанияПоДоговорам(МассивДоговоровВход)

ОповеститьПользователейОбИзмененииСостояния

Описание, пример вызова

Процедура ОповеститьПользователейОбИзмененииСостояния(ТекЗапись,ОбъектОповещенияСсылка) Экспорт

Пример вызова

МодульУправленияОповещениямиУХ.ОповеститьПользователейОбИзмененииСостояния(ТекЗапись, ОбъектОповещенияСсылка)