You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Этот класс позволяет пользовательскому скрипту выполнять код на стороне сервера, используя Внешние скрипты. Используйте этот класс для создания уведомлений.

setTitle(title)


Используйте этот метод для настройки основного заголовка почтового уведомления.

Параметры:

Название

Тип

Обязательный

Значение по умолчанию

titleStringДаНет

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

Тип

Описание

VoidЭтот метод не возвращает значение.

Пример:

setTitle
 ss.importIncludeScript('SimpleEmailTemplate');
 const htmlTemplate = new SimpleEmailTemplate('');
 htmlTemplate.setTitle(`${current.number} ${current.subject}`);

setBodyHeader(bodyHeader)


Используйте этот метод для настройки заголовка для тела текста почтового уведомления.

Параметры:

Название

Тип

Обязательный

Значение по умолчанию

bodyHeaderStringДаНет

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

Тип

Описание

VoidЭтот метод не возвращает значение.

Пример:

setBodyHeader
  let bodyHeaderTemplate = `<a href="${currentRecordURL}">${emailSubject}</a> <br> Статус ${current.number} изменился, новый статус: ${current.getDisplayValue('state')}.`;
  if(current.state == '3'){ //Отложено
      bodyHeaderTemplate += `Повторный запрос: ${current.getDisplayValue('resubmission')}`;       
}
  bodyHeaderTemplate += `<br><br>Вы можете дополнить инфомацию в ответном письме. Не меняйте тему письма. `;
  htmlTemplate.setBodyHeader(bodyHeaderTemplate);

setBodyText(bodyText)


Используйте этот метод, чтобы задать основной текст уведомления по электронной почте.

Параметры:

Название

Тип

Обязательный

Значение по умолчанию

bodyTextStringДаНет

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

Тип

Описание

VoidЭтот метод не возвращает значение.

Пример:

setBodyText
const htmlTemplate = new SimpleEmailTemplate(approvalItem.getDisplayValue());
const allApproversObject = JSON.parse(current.additional_parameter);
htmlTemplate.setBodyText(`Уважаемый ${current.getDisplayValue('approver_id')}, согласуйте <a href="${ApprovalItemURL}">${approvalItem.getDisplayValue()}</a> Список тикетов на согласование: ${transformToTemplateList(allApproversObject)}`);

setComment(comment)


Этот метод предназначен для настройки комментариев в почтовых уведомлениях:

  • расположение комментариев в поле на сером фоне,
  • подсветка курсивом.

Параметры:

Название

Тип

Обязательный

Значение по умолчанию

commentStringДаНет

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

Тип

Описание

VoidЭтот метод не возвращает значение.

Пример:

setComment
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setComment(`Comment: ${current.additional_comments}`);

getTitle()


Данный метод возвращает основной заголовок уведомления

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

Тип

Описание

StringОсновной заголовок уведомления

Пример:

getTitle
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setTitle(`${current.number} ${current.subject}`);
ss.info(htmlTemplate.getTitle()); // Результат: INC0000XXX Email не работает

getBodyHeader()


Этот метод возвращает основной заголовок основного текста.

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

Тип

Описание

StringОсновной заголовок в теле текста

Пример:

getBodyHeader
 ss.importIncludeScript('SimpleEmailTemplate');
 const htmlTemplate = new SimpleEmailTemplate('');
 htmlTemplate.setBodyHeader(`Инцидент ${current.number} ${current.subject}`);
 ss.info(htmlTemplate.getBodyHeader()); // Результат: Инцидент INC0000XX Email не работает

getBodyText()


Этот метод возвращает основной текст письма.

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

Тип

Описание

StringОсновной текст

Пример:

getBodyText
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setBodyText(`Description ${current.description}`);
ss.info(htmlTemplate.getBodyText()); // Результат: Описание 27.01.2022 Не смог зайти в свой email, ошибка 'Нет доступа'. 

getComment()


Этот метод возвращает текст комментариев.

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

Тип

Описание

StringТекст комментариев.

Пример:

getComment
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setComment(`Comment: ${current.additional_comments}`);
ss.info(htmlTemplate.getComment()); // Результат: Необходимо больше информации

getButtons()


Данный метод возвращает массив кнопок.

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

Тип

Описание

ArrayМассив кнопок

Пример:

getButtons
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.addButton('Approve', 'https://instance.example.com');
ss.info(htmlTemplate.getButtons()); // Результат: [{"text":"Approve","url":"https:\/\/instance.example.com\/","color":"#05C270"},{"text":"Reject","url":"https:\/\/instance.example.com\/","color":"#F73422"}]

addButton()


Используйте этот метод, чтобы добавить новую кнопку к массиву кнопок.
Параметры:

Название

Тип

Обязательный

Значение по умолчанию

textStringДаНет
urlStringДаНет
colorStringНетНет
buttonArrayArrayДаНет

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

Тип

Описание

ArrayМассив кнопок, включая новую
addButtons
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.addButton('Approve', 'https://instance.example.com');

removeButton()


Используйте этот метод, чтобы удалить последнюю добавленную кнопку.

Пример:

removeButton
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.addButton('Approve', 'https://instance.example.com');
if (current.state === '2') { // Статус инцидента 'В работе' 
    htmlTemplate.removeButton();
}

removeAllButtons()


Используйте этот метод, чтобы удалить все добавленные кнопки.

Пример:

removeAllButtons
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.addButton('Approve', 'https://instance.example.com');
htmlTemplate.addButton('Reject', 'https://instance.example.com');
if (current.state === '3') { Incident in the 'Postponed' state
   htmlTemplate.removeAllButtons();
 }

setProperty(propertyName, input, propertyTitle)


Используйте этот метод, чтобы задать внутренний метод проверки типа ввода.

Параметры:

Название

Тип

Обязательный

Значение по умолчанию

propertyNameStringДаНет
inputString/NumberДаНет
propertyTitleStringДаНет

Пример:

setProperty
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setProperty('bodyText', Need information about the incident', 'Body Text'); 
ss.info(htmlTemplate.getBodyText()); // Результат: Необходимо больше информации об инциденте

formEmailTemplate()


Этот метод создает и возвращает HTML шаблон на основе заданных свойств.

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

Тип

Описание

StringШаблон HTML 

Пример:

formEmailTemplate
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setTitle(`${current.number} ${current.subject}`);
htmlTemplate.setComment(`Comment: ${current.additional_comments}`);
htmlTemplate.setBodyHeader(`Incident ${current.number} ${current.subject}`);
htmlTemplate.setBodyText(`Description: ${current.description}`);
email.setBody(htmlTemplate.formEmailTemplate());

  • No labels