Документация для разработчиков
Темная тема

GetMessageList

Описание и параметры

record set
CTicket::GetMessageList(
	varchar &by,
	varchar &order,
	array arFilter=array(),
	boolean &is_filtered,
	char(1) CHECK_RIGHTS="Y",
	char(1) get_user_name="Y"
);

Метод предназначен для получения списка сообщений в одном обращении. Метод нестатический.

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

ПараметрОписаниеС версииУдалён с версии
TICKET_ID 3.3.16
byИдентификатор позволяющий задать имя поля для сортировки. Допустимы следующие значения:
  • s_id - по ID
  • s_number - по порядковому номеру
3.3.16
orderПорядок сортировки. Допустимы следующие значения:
  • desc - по убыванию
  • asc - по возрастанию (значение по умолчанию)
3.3.16
arFilter Массив для фильтрации значений. В массиве допустимы следующие индексы:
  • ID - ID сообщения (допускается сложная логика);
  • TICKET_ID - ID обращения;
  • TICKET - (допускается сложная логика);
  • IS_MESSAGE - Позволяет получить список именно сообщений. В противном случае в списке сообщений будет много мусора, например, сообщения об изменении статуса.
  • IS_HIDDEN - "Y" - будут выбраны только скрытые сообщения; "N" - будут выбраны все не скрытые сообщения;
  • IS_LOG - "Y" - будут выбраны только лог-записи (записи изменений); "N" - будут выбраны не лог-записи;
  • IS_OVERDUE - "Y" - будут выбраны только просроченные сообщения; "N" - будут выбраны не просроченные сообщения;
  • NOT_CHANGE_STATUS - "Y" - будут выбраны только неизменённые сообщения; "N" - будут выбраны изменённые сообщения;
  • MESSAGE_BY_SUPPORT_TEAM - "Y" - будут выбраны сообщения от сотрудников техподдержки; "N" - будут выбраны все сообщения;
  • EXTERNAL_FIELD_1 - (допускается сложная логика)
Необязательный параметр.
3.3.11
is_filteredПеременная возвращающая true в том случае если список результатов отфильтрован по какому либо критерию; либо false в противном случае. Изменен на isFiltered с версии 12.0.03.3.16
CHECK_RIGHTS Флаг необходимости проверки прав текущего пользователя:
  • Y - будут выбраны только те сообщения которые данные пользователь может просматривать (по умолчанию)
  • N - выбирать все сообщения независимо от прав текущего пользователя
Необязательный параметр. Изменен на checkRights с версии 12.0.0
3.3.11
get_user_name Необязательный параметр. "Y" - при выборке сообщения будут также выбраны такие поля, как OWNER_EMAIL, OWNER_LOGIN, OWNER_NAME, CREATED_EMAIL, CREATED_LOGIN, CREATED_NAME, MODIFIED_EMAIL, MODIFIED_LOGIN, MODIFIED_NAME, описывающие параметры пользователей имевших отношение к данному сообщению (по умолчанию); "N" - вышеперечисленные поля не будут выбраны, но зато это ускорит работу метода. Изменен на getUserName с версии 12.0.0 3.3.16
old_callНеобязательный параметр. Значение по умолчанию - "N".3.3.153.3.16

Примеры использования

<?
$mess = CTicket::GetMessageList($a, $b, array("TICKET_ID" => $ID, "TICKET_ID_EXACT_MATCH" => "Y"), $c, $CHECK_RIGHTS);
$mess->NavStart(50);
$messages = $mess->SelectedRowsCount();
?>


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
webrover
В массиве фильтра очень полезный элемент "IS_MESSAGE" => "Y". В этом случае можно получить список именно сообщений. В противном случае в списке сообщений будет много мусора, например, сообщения об изменении статуса.
0
Evgenius
Структура возвращаемых записей приведена на странице функции CTicket::GetMessageByID
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх