Интеграция средства "Выбор людей"

Выбор людей — это управление для поиска и выбора людей. Это родной потенциал, доступный в Teams платформе. Вы можете интегрировать Teams управления входными данными пользователей с веб-приложениями. Можно выбрать между одним или несколькими выборами и конфигурациями, например ограничением поиска в чате, каналах или во всей организации.

Вы можете использовать Microsoft Teams JavaScript клиента SDK,который предоставляет API для интеграции выборщика людей selectPeople в вашем веб-приложении.

Преимущества интеграции родного выборщика людей

  • Управление выборщиком людей работает во всех Teams, таких как модуль задач, чат, канал, вкладка собраний и личное приложение.
  • Этот контроль позволяет искать и выбирать пользователей в чате, канале или всей организации.
  • Выбор людей помогает в сценариях, связанных с назначением задач, тегами, оповещать пользователя.
  • Этот легкодоступный контроль можно использовать в веб-приложении. Это значительно экономит усилия и время для создания такого управления самостоятельно.

Необходимо вызвать selectPeople API для интеграции управления выборщиком людей в Teams приложении. Для эффективной интеграции необходимо иметь представление о фрагменте кода для вызова API. Важно ознакомиться с ошибками ответа API для обработки ошибок в веб-приложении.

Примечание

В настоящее время Microsoft Teams для людей Picker доступна только для мобильных клиентов.

selectPeople API

selectPeopleAPI позволяет добавлять Teams в People Picker input control веб-приложения.
Описание API следующим образом:

API Описание
selectPeople Запускает выбор людей и позволяет пользователю искать и выбирать одного или несколько человек из списка.

Этот API возвращает ID, имя и адрес электронной почты выбранных пользователей в вызываемом веб-приложении.

В случае личного приложения управление выполняет поиск по всей организации. Если приложение добавляется в чат или канал, контекст поиска настраивается в зависимости от сценария. Поиск ограничен членами этого чата, канала или доступен в организации.

API selectPeople поставляется вместе со следующими конфигурациями ввода:

Параметр Конфигурация Тип Описание Значение по умолчанию
title String Это необязательный параметр. Он задает название для управления выборщиком людей. Выбор людей
setSelected String Это необязательный параметр. Необходимо передать AAD-ID людей, которые будут предварительно отбираться. Этот параметр предварительно отбирает людей при запуске управления выборщиком людей. В случае единого выбора только первый допустимый пользователь будет предварительно заселяться, игнорируя остальные. Null
openOrgWideSearchInChatOrChannel Логический Это необязательный параметр. Если установлено, что это верно, он запускает выбор людей в широкой области организации, даже если приложение добавлено в чат или канал. Неверно
singleSelect Boolean Это необязательный параметр. Когда установлено, что это верно, запускается выборщик людей, ограничивающий выбор только для одного пользователя. False

На следующем изображении описывается опыт выборки людей в примере веб-приложения:

Веб-приложение выборщика людей

Фрагмент кода

Вызов selectPeople API для выбора людей из списка:

 microsoftTeams.people.selectPeople((error: microsoftTeams.SdkError, people: microsoftTeams.people.PeoplePickerResult[]) => 
 {
    if (error) 
    {
        if (error.message) 
           {
             alert(" ErrorCode: " + error.errorCode + error.message);
           }
            else 
            {
              alert(" ErrorCode: " + error.errorCode);
            }
      }
    if (people)
     {
            output(" People length: " + people.length + " " + JSON.stringify(people));
      }
  });

Обработка ошибок

Необходимо обеспечить надлежащее обработку ошибок в веб-приложении. В следующей таблице перечислены коды ошибок и условия, при которых создаются ошибки:

Код ошибки Имя ошибки Condition
100 NOT_SUPPORTED_ON_PLATFORM API не поддерживается на текущей платформе.
500 INTERNAL_ERROR Внутренняя ошибка встречается при запуске выборщика людей.
4000 INVALID_ARGUMENTS API вызывается с неправильными или недостаточными обязательными аргументами.
8000 USER_ABORT Пользователь отменил операцию.
9000 OLD_PLATFORM Пользователь находится на старой сборке платформы, где нет реализации API. Обновление сборки устраняет проблему.

См. также