Стандартные провайдеры в ui.entity-selector

Bitrix Framework регистрирует стандартные провайдеры данных для пользователей, отделов, проектов, чатов и чат-ботов. Чтобы использовать такой тип объекта в Dialog или TagSelector, подключите модуль, который его регистрирует.

В JavaScript передавайте идентификатор стандартного провайдера в поле entities[].id. Например, для провайдера user используйте entities: [{ id: 'user' }].

Параметры провайдера передавайте в EntityOptions.options. Связь настроек dynamicLoad, dynamicSearch, preselectedItems и методов PHP-провайдера описана в статье Провайдеры данных.

Если нужного типа объекта нет среди стандартных, зарегистрируйте собственный провайдер данных.

useruser

Провайдер Bitrix\Socialnetwork\Integration\UI\EntitySelector\UserProvider ищет и возвращает пользователей текущей установки. Модуль: socialnetwork. entityId: user.

Провайдер автоматически заполняет вкладку «Последние» первыми пользователями текущей установки и историей выбора текущего контекста. Если установлен модуль intranet, провайдер может добавить в футер диалога ссылку приглашения сотрудника или внешнего пользователя.

const dialog = new Dialog({
            targetNode: button,
            enableSearch: true,
            context: 'MY_MODULE_RESPONSIBLE',
            entities: [
                {
                    id: 'user',
                    options: {
                        intranetUsersOnly: true,
                        inviteEmployeeLink: false,
                    },
                },
            ],
        });
        

Отбор пользователей

Оформление и футер

Загрузка

departmentdepartment

Провайдер Bitrix\Intranet\Integration\UI\EntitySelector\DepartmentProvider строит дерево структуры компании. Модули: intranet, socialnetwork, iblock. entityId: department.

Провайдер автоматически добавляет вкладку «Отделы» с деревом подразделений. Режим selectMode определяет, что можно выбрать: сотрудников, отделы целиком или оба варианта.

const dialog = new Dialog({
            targetNode: button,
            enableSearch: true,
            context: 'MY_MODULE_RESPONSIBLE',
            entities: [
                {
                    id: 'department',
                    options: {
                        selectMode: 'usersAndDepartments',
                        allowFlatDepartments: true,
                    },
                },
            ],
        });
        

projectproject

Провайдер Bitrix\Socialnetwork\Integration\UI\EntitySelector\ProjectProvider возвращает группы и проекты, в которых участвует текущий пользователь. Модуль: socialnetwork. entityId: project.

Провайдер автоматически добавляет вкладку «Группы» и, если пользователь может создать проект, футер со ссылкой создания.

const dialog = new Dialog({
            targetNode: button,
            enableSearch: true,
            context: 'MY_MODULE_RESPONSIBLE',
            entities: [
                {
                    id: 'project',
                    options: {
                        extranet: false,
                        type: ['group'],
                    },
                },
            ],
        });
        

Отбор проектов

Полный набор значений type зависит от типов проектов, доступных в модуле socialnetwork. Если значение не подтверждено для текущей установки, не передавайте этот параметр.

Загрузка и футер

Для выбора кодов доступа проектов используйте провайдер Bitrix\Socialnetwork\Integration\UI\EntitySelector\ProjectAccessCodesProvider. entityId провайдера — project-access-codes.

const dialog = new Dialog({
            targetNode: button,
            context: 'MY_MODULE_PROJECT_ACCESS',
            entities: [
                {
                    id: 'project-access-codes',
                    dynamicLoad: true,
                    dynamicSearch: true,
                },
            ],
        });
        

meta-usermeta-user

Провайдер Bitrix\Socialnetwork\Integration\UI\EntitySelector\MetaUserProvider добавляет в диалог составные элементы, которые обозначают группу пользователей, а не одного человека. Модуль: socialnetwork. entityId: meta-user.

Провайдер возвращает элементы all-users («Все сотрудники» или «Все пользователи») и other-users («Остальные сотрудники» или «Остальные пользователи»). Сценарий, который использует диалог, сам разворачивает эти значения в список конкретных пользователей.

const dialog = new Dialog({
            targetNode: button,
            context: 'MY_MODULE_RESPONSIBLE',
            entities: [
                { id: 'user' },
                {
                    id: 'meta-user',
                    options: {
                        'all-users': { title: 'Все сотрудники компании' },
                    },
                },
            ],
        });
        

Параметры all-users и other-users принимают одинаковый набор вложенных полей:

im-chatim-chat

Провайдер Bitrix\Im\Integration\UI\EntitySelector\ChatProvider ищет и возвращает чаты текущего пользователя. Модуль: im. entityId: im-chat.

Провайдер автоматически заполняет вкладку «Последние» недавними чатами. При открытии выше показываются новые чаты, а при поиске — чаты с более поздними сообщениями.

Каждый элемент содержит в customData ключ imChat с данными чата. Используйте этот ключ в обработчике выбора, если сценарию нужен идентификатор или параметры чата из модуля im.

const dialog = new Dialog({
            targetNode: button,
            enableSearch: true,
            context: 'MY_MODULE_RESPONSIBLE',
            entities: [
                {
                    id: 'im-chat',
                    options: {
                        searchableChatTypes: ['C', 'L', 'O'],
                    },
                },
            ],
        });
        

Для интранет-пользователей поиск ищет среди групповых чатов и открытых линий, где участвует пользователь, и среди всех открытых каналов. Для экстранет-пользователей поиск ограничен групповыми чатами.

im-botim-bot

Провайдер Bitrix\Im\Integration\UI\EntitySelector\BotProvider ищет и возвращает чат-ботов текущей установки. Модуль: im. entityId: im-bot. Провайдер недоступен для внешних (экстранет) пользователей.

Провайдер автоматически заполняет вкладку «Последние» ботами. В поиске и среди уже сохраненных недавних ботов выше показываются те, кому пользователь отправил больше сообщений. Остальные боты во вкладке добираются в порядке новизны регистрации.

Каждый элемент содержит в customData ключи imBot, imUser и imChat с данными бота. imBot относится к боту, imUser — к связанному пользователю, imChat — к чату бота.

const dialog = new Dialog({
            targetNode: button,
            enableSearch: true,
            context: 'MY_MODULE_RESPONSIBLE',
            entities: [
                {
                    id: 'im-bot',
                    options: {
                        searchableBotTypes: ['H', 'B', 'S'],
                    },
                },
            ],
        });
        

im-recentim-recent

Провайдер Bitrix\Im\Integration\UI\EntitySelector\RecentChatProvider заполняет вкладку «Последние» элементами из списка последних чатов пользователя. Модуль: im. entityId: im-recent.

Провайдер использует динамическую загрузку и не выполняет поиск. Для поиска подключайте вместе с ним провайдеры user, im-chat и im-bot с отключенным автозаполнением диалога.

const dialog = new Dialog({
            targetNode: button,
            enableSearch: true,
            entities: [
                {
                    id: 'im-bot',
                    options: {
                        searchableBotTypes: ['H', 'B', 'S'],
                        fillDialog: false,
                    },
                },
                {
                    id: 'im-chat',
                    options: {
                        searchableChatTypes: ['C', 'L', 'O'],
                        fillDialog: false,
                    },
                },
                {
                    id: 'user',
                    options: {
                        fillDialog: false,
                    },
                    filters: [
                        {
                            id: 'im.userDataFilter',
                        },
                    ],
                },
                {
                    id: 'im-recent',
                    dynamicLoad: true,
                    options: {
                        limit: 100,
                    },
                },
            ],
        });
        

Элементы, которые добавляет im-recent, получают entityId не от самого провайдера, а по типу элемента списка: user, im-chat или im-bot. Для чатов провайдер добавляет в customData ключ imChat, для пользователей — imUser, для чат-ботов — imUser и imBot.

Провайдер создает элементы с saveable: false, поэтому сам элемент из списка последних чатов не сохраняется повторно в недавние элементы ui.entity-selector.

im.userDataFilterim.userDataFilter

Фильтр Bitrix\Im\Integration\UI\EntitySelector\UserDataFilter дополняет элементы провайдера user данными модуля im. Фильтр используется в entities[].filters с идентификатором im.userDataFilter.

const dialog = new Dialog({
            targetNode: button,
            enableSearch: true,
            entities: [
                {
                    id: 'user',
                    dynamicLoad: true,
                    filters: [
                        {
                            id: 'im.userDataFilter',
                        },
                    ],
                },
            ],
        });
        

Фильтр доступен авторизованным пользователям. При обработке элементов он добавляет в customData ключ imUser с данными пользователя из модуля im. Если элемент относится к текущему пользователю, фильтр добавляет бейдж «Это вы».

Использовать стандартный тип объектаИспользовать стандартный тип объекта

Идентификатор встроенного провайдера (entityId) передайте в поле entities[].id. Собственный провайдер регистрировать не нужно: сервер найдет встроенный провайдер по идентификатору типа объекта.

import { Dialog } from 'ui.entity-selector';
        
        const dialog = new Dialog({
            targetNode: button,
            enableSearch: true,
            context: 'MY_MODULE_RESPONSIBLE',
            entities: [
                {
                    id: 'user',
                    dynamicLoad: true,
                    dynamicSearch: true,
                },
            ],
        });
        

Модуль, который регистрирует нужный провайдер (socialnetwork, intranet или im), должен быть установлен в текущей установке. Без установленного модуля метод isAvailable() провайдера вернет false, и диалог не покажет элементы этого типа объекта.

Для стандартных провайдеров флаги dynamicLoad и dynamicSearch можно передавать в конкретном диалоге явно. Явная передача флагов фиксирует сценарий в коде и не зависит от глобальных настроек типа объекта.

Если элементы стандартного типа не отображаются, проверьте:

• в entities[].id передан правильный entityId: user, department, project, meta-user, im-chat, im-bot или im-recent;
• установлен модуль, который регистрирует провайдер;
• текущему пользователю доступны элементы этого типа;
• фильтры в options не исключают все элементы;
• для чатов явно передан searchableChatTypes, если нужно находить новые чаты в поиске или при автозаполнении.