Integrar Selector de personas

Selector de personas es un control de entrada en Teams que permite a los usuarios buscar y seleccionar personas. Puede integrar el control de entrada Selector de personas en una aplicación web, lo que permite a los usuarios finales realizar diferentes funciones, como buscar y seleccionar personas en un chat, canal o en toda la organización dentro de Teams. El control Selector de personas está disponible en todos los clientes de Teams, ya sea en la Web, el escritorio o el móvil.

Puede usar la biblioteca cliente javaScript de Microsoft Teams, que proporciona la selectPeople API para integrar el control de entrada Selector de personas en la aplicación web.

Ventajas del uso de Selector de personas

• Funciona en todas las funcionalidades de Teams, como el cuadro de diálogo (denominado módulo de tareas en TeamsJS v1.x), el chat, el canal, la pestaña de reunión y la aplicación personal.
• Permite al usuario buscar y seleccionar personas en un chat, canal o toda la organización dentro de Teams.
• Ayuda en escenarios que implican la asignación de tareas, el etiquetado y la notificación al usuario.
• Ahorra mucho tiempo y esfuerzo en comparación con la creación de cualquier control similar.

Para integrar el control de entrada de Selector de personas en la aplicación Teams, use la API selectPeople. Para integrar y llamar a la API, debe comprender bien el fragmento de código adjunto. También necesita familiarizarse con los errores de respuesta de la API.

API selectPeople

La API selectPeople le permite agregar el control de entrada de Selector de personas en Teams a las aplicaciones web y también le ayuda con lo siguiente:

• Permite al usuario buscar y seleccionar una o más personas de la lista.
• Devuelve el identificador, el nombre y la dirección de correo electrónico de los usuarios seleccionados a la aplicación web.

En una aplicación personal, el control busca el nombre o el identificador de correo electrónico en toda la organización dentro de Teams. Si la aplicación se agrega a un chat o canal, el contexto de búsqueda se configura en función del escenario. La búsqueda está restringida a los miembros de ese chat o canal.

La API selectPeople incluye las siguientes configuraciones de entrada:

Parámetro de configuración	Tipo	Descripción	Valor predeterminado
title	Cadena	Es un parámetro opcional y establece el título del control Selector de personas.	selectPeople
setSelected	Cadena	Es un parámetro opcional. Debe pasar los identificadores de Microsoft Entra de las personas que se van a preseleccionar. Este parámetro preselecciona a las personas al iniciar el control de entrada Selector de personas. En una sola selección, solo el primer usuario válido se rellena previamente ignorando el resto.	Null
openOrgWideSearchInChatOrChannel	Boolean	Es un parámetro opcional y cuando se establece en True, inicia el Selector de personas en el ámbito de toda la organización incluso si la aplicación se agrega a un chat o canal.	False
singleSelect	Boolean	Es un parámetro opcional y cuando se establece en True, inicia el Selector de personas y restringe la selección a un solo usuario.	False

En la siguiente imagen se muestra la experiencia del Selector de personas en dispositivos móviles y de escritorio:

Móvil

El control de entrada de Selector de personas permite al usuario buscar y agregar personas mediante los siguientes pasos:

1. Escriba el nombre de la persona que quiere invitar. La lista aparece con sugerencias de nombre.

2. Seleccione el nombre de la persona necesaria de la lista.

   

Escritorio

El control Selector de personas en la web o el escritorio se inicia en una ventana modal en la parte superior de la aplicación web y para agregar personas, siga estos pasos:

1. Escriba el nombre de la persona que quiere invitar. La lista aparece con sugerencias de nombre.

2. Seleccione el nombre de la persona necesaria de la lista.

   

Fragmento de código

El siguiente fragmento de código muestra el uso de los usuarios de la API selectPeople de una lista:

TeamsJS v2

people.selectPeople({ setSelected: ["aad id"], openOrgWideSearchInChatOrChannel: true, singleSelect: false, title: true}).then(people) => 
 {
    output(" People length: " + people.length + " " + JSON.stringify(people));
 }).catch((error) => { /*Unsuccessful operation*/ });

TeamsJS v1

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));
      }
  },{ setSelected: ["aad id"], openOrgWideSearchInChatOrChannel: true, singleSelect: false, title: true});

Control de errores

En la tabla siguiente se enumeran los códigos de error y sus descripciones:

Código de error	Nombre de error	Descripción
100	NOT_SUPPORTED_ON_PLATFORM	La API no se admite en la plataforma actual.
500	INTERNAL_ERROR	Error interno detectado al iniciar Selector de personas.
4000	InvalidArguments	La API se invoca con argumentos obligatorios incorrectos o insuficientes.
8000	USER_ABORT	El usuario canceló la operación.
9000	OLD_PLATFORM	El usuario se encuentra en una compilación de plataforma antigua donde la implementación de la API no está disponible. Actualice a la versión más reciente de la compilación para resolver el problema.

Ejemplo de código

Ejemplo de nombre	Descripción	.NET	Node.js	Manifiesto
Selector de personas con tabulación	En este ejemplo se muestra la característica del selector de personas mediante el sdk de cliente de teams js dentro de la pestaña .	View	View	Ver

Consulte también

• Integrar capacidades multimedia
• Integrar la funcionalidad de escáner de código QR o código de barras en Teams
• Integrar las capacidades de ubicación en Teams
• Componente selector de personas en Microsoft Graph Toolkit