Предусмотрено две одноименных функции: ШаблоныСообщений.ОписаниеПараметровШаблона для вызова с сервера ШаблоныСообщенийКлиентСервер.ОписаниеПараметровШаблона для вызова с клиента

1. Для вызова с сервера

Возвращает описание параметров шаблона.

Синтаксис

Функция ОписаниеПараметровШаблона() Экспорт

Возвращаемое значение

Структура:

• Наименование - Строка - наименование шаблона сообщений.
• Текст - Строка - текст шаблона письма или сообщения SMS.
• Тема - Строка - текст темы письма. Только для шаблонов электронной почты.
• ТипШаблона - Строка - тип шаблона. Варианты: "Письмо","SMS".
• Назначение - Строка - представление предмет шаблона сообщений. Например, Заказ покупателя.
• ПолноеИмяТипаНазначения - Строка - предмет шаблона сообщений. Если указан полный путь к объекту метаданных, то в шаблоне в качестве параметров будут доступны все его реквизиты. Например, Документ.ЗаказПокупателя.
• ФорматПисьма - ПеречислениеСсылка.СпособыРедактированияЭлектронныхПисем- формат письма HTML или обычный текст. Только для шаблонов электронной почты.
• УпаковатьВАрхив - Булево - если Истина, то печатные формы и вложения будут упакованы в архив при отправке. Только для шаблонов электронной почты.
• ТранслитерироватьИменаФайлов - Булево - печатные формы и файлы, вложенные в письмо будут иметь имена, содержащие только латинские буквы и цифры, для возможности переноса между различными операционными системами. Например, файл "Счет на оплату.pdf" будет сохранен с именем "Schet na oplaty.pdf". Только для шаблонов электронной почты.
• ФорматыВложений - СписокЗначений - список форматов вложений. Только для шаблонов электронной почты.
• Вложения - Соответствие из КлючИЗначение: ** Ключ - Строка - имя файла с расширением (например, image.png). Наименование будет без расширения. Или идентификатор картинки в html-письме (без cid). ** Значение - Строка - адрес, указывающий на двоичные данные файла во временном хранилище.
• КомандыПечати - Массив из Строка - уникальные идентификаторы печатных форм
• ВладелецШаблона - ОпределяемыйТип.ВладелецШаблонаСообщения - владелец контекстного шаблона.
• ШаблонПоВнешнейОбработке - Булево - если Истина, то шаблон формируется внешней обработкой.
• ВнешняяОбработка - СправочникСсылка.ДополнительныеОтчетыИОбработки - внешняя обработка, в которой содержится шаблон.
• ПодписьИПечать - Булево - добавляет факсимильную подпись и печать в печатную форму. Только для шаблонов электронной почты.
• ДобавлятьПрисоединенныеФайлы - Булево - если Истина, то к вложениям письма будут добавлены все присоединенные файлы предмета-владельца.

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

Результат = ШаблоныСообщений.ОписаниеПараметровШаблона()

Доступность

Сервер, Толстый клиент, Внешнее соединение

2. Для вызова с клиента и сервера

Конструктор параметров шаблона.

Синтаксис

Функция ОписаниеПараметровШаблона() Экспорт

Возвращаемое значение

Структура - список параметров шаблона, где:

• Тема - Строка - тема шаблонов (для электронных писем).
• Текст - Строка - текст шаблона;
• ПодписьИПечать - Булево - признак подписи и печати в печатных формах;
• ПараметрыСообщения - Структура - дополнительные параметры сообщения;
• Наименование - Строка - наименование шаблона сообщения;
• Ссылка - Неопределено - ссылка на элемент справочника;
• ВладелецШаблона - Неопределено - владельца контекстного шаблона;
• ПараметрыСКД - Соответствие - набор параметров при получении данных с использованием СКД;
• Параметры - Соответствие - параметры шаблона;
• Макет - Строка - имя макета СКД;
• ВыбранныеВложения - Соответствие - выбранные печатные формы и вложения в шаблон;
• ФорматыВложений - СписокЗначений - формат, в котором сохраняются печатные формы;
• РазворачиватьСсылочныеРеквизиты - Булево - если Истина, то у ссылочных реквизитов доступны их реквизиты.
• ШаблонПоВнешнейОбработке - Булево - если Истина, то шаблон формирует внешней обработкой;
• ВнешняяОбработка - Неопределено - ссылка на внешнюю обработку;
• Отправитель - Строка - электронная почта отправителя;
• ПеревестиВТранслит - Булево - если Истина, то сформированные печатные формы и файлы будут иметь имена, содержащие только латинские буквы и цифры, для возможности переноса между различными операционными системами. Например, файл "Счет на оплату.pdf" будет сохранен с именем "Schet na oplaty.pdf";
• УпаковатьВАрхив - Булево - признак того, что вложения и печатные формы должны быть упакованы в архив при отправке;
• ФорматПисьма - ПеречислениеСсылка.СпособыРедактированияЭлектронныхПисем - вид текста письма: HTML или ОбычныйТекст;
• ПолноеИмяТипаНазначения - Строка - полное имя объекта метаданных, на основании которого создается сообщения;
• Назначение - Строка - назначение шаблона сообщений;
• ТипШаблона - Строка - варианты: "Письмо" или "SMS".

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

Результат = ШаблоныСообщенийКлиентСервер.ОписаниеПараметровШаблона()

Доступность

Сервер, Тонкий клиент, Толстый клиент, Внешнее соединение