api.utils Работа с комментариями

Для доступа к операциям используется утилитарный метод api.utils или его короткий псевдоним utils.

  • utils.comments(subject)

    Получение списка комментариев.

    Параметр метода:

    • subject — объект, для которого отображается список комментариев.

    Возвращает список комментариев объекта, упорядоченных хронологически (по времени добавления).

  • utils.create(objCode, attributes)

    Добавление комментария к объекту.

    Параметры метода:

    • objCode — код метакласса создаваемого объекта;
    • attributes — ассоциативный список кодов изменяемых атрибутов и устанавливаемых значений.

    Пример 1. Добавление комментария к запросу:

    def serviceCall = utils.get('serviceCall$3801');
    utils.create('comment', ['text' : 'Текст комментария', 'source' : serviceCall])

    Пример 2. Добавление комментария с указанием автора:

    def serviceCall = utils.get('serviceCall$3801');
    utils.create('comment', ['text' : 'Текст комментария', 'author' : user, 'source' : serviceCall])

    Пример 3. Добавление приватного комментария к запросу:

    def serviceCall = utils.get('serviceCall$3801');
    utils.create('comment', ['text' : 'Текст комментария', 'private' : true, 'source' : serviceCall])
  • utils.edit(obj, attributes)

    Добавлять комментарии к объекту через utils.edit не рекомендуется, так как вызывает выполнение действие по событию на изменение объекта.
    Добавление комментария через utils.edit следует использовать, если "Комментарий" обязателен для заполнения при изменении статуса объекта.

    Для добавления комментария к объекту рекомендуется использовать utils.create.

    Параметры метода:

    • obj — объект, к которому добавляется комментарий;
    • attributes = @comment' для добавления комментария;
    • attributes ='@commentAuthor' для указания автора добавляемого комментария;
    • attributes ='@isCommentPrivate' для добавления приватного комментария.

    Пример 1. Добавление комментария к запросу, используется '@comment' (комментарий). Если включить действие по событию на изменение объекта типа "скрипт" с содержимым скрипта из примера, то действие по событию будет выполняться трижды при любом изменении редактируемого объекта serviceCall, каждый раз добавляя комментарий

    def serviceCall = utils.get('serviceCall$3801');
    utils.edit(serviceCall, ['@comment' : 'Текст комментария'])

    Пример 2. Добавление комментария с указанием автора, используется '@commentAuthor' (автор добавляемого комментария):

    def serviceCall = utils.get('serviceCall$3801');
    utils.edit(serviceCall, ['@comment' : 'Текст комментария', '@commentAuthor' : user]);

    Пример 3. Добавление приватного комментария к запросу, используется '@isCommentPrivate' (признак приватности комментария):

    def serviceCall = utils.get('serviceCall$3801');
    utils.edit(serviceCall, ['@comment' : 'Текст комментария', '@isCommentPrivate' : true]);
  • utils.lastComment(subject)

    Получение последнего комментария объекта.

    Параметр метода:

    • subject — объект, для которого получаем последний комментарий.

    Возвращает последний (по времени добавления) комментарий объекта.