Crear pestañas y otras experiencias hospedadas con el SDK Microsoft Teams cliente de JavaScript

Artículo
11/18/2021
Tiempo de lectura: 4 minutos

El SDK Microsoft Teams cliente de JavaScript puede ayudarte a crear experiencias hospedadas en Teams, lo que significa mostrar el contenido de la aplicación en un iframe.

El SDK es útil para desarrollar aplicaciones con cualquiera de las siguientes Teams funcionalidades:

Por ejemplo, el SDK puede hacer que la pestaña reaccione a los cambios de tema que los usuarios realicen en el Teams cliente.

Introducción

Realice una de las siguientes acciones según sus preferencias de desarrollo:

Funciones comunes de SDK

Consulta las tablas siguientes para comprender las funciones de SDK que se usan con frecuencia. La documentación de referencia del SDK proporciona información más completa.

Funciones básicas

Función	Descripción	Documentación
`microsoftTeams.initialize()`	Inicializa el SDK. Se debe llamar a esta función antes de cualquier otra llamada del SDK.	function
`microsoftTeams.getContext(callback: (context: Context)`	Obtiene el estado actual en el que se está ejecutando la página. La devolución de llamada recupera el objeto Context.	function context obj
`microsoftTeams.initializeWithContext({contentUrl: string, websiteUrl: string})`	Inicializa la biblioteca Teams y establece el contexto de marco de la pestaña en función de contentUrl y websiteUrl. Esto garantiza que la funcionalidad de ir al sitio web/recargar funciona en la dirección URL correcta.	function
`microsoftTeams.setFrameContext({contentUrl: string, websiteUrl: string})`	Establece el contexto de marco de la pestaña en función de contentUrl y websiteUrl. Esto garantiza que la funcionalidad de ir al sitio web/recargar funciona en la dirección URL correcta.	function
`microsoftTeams.registerFullScreenHandler(handler: (isFullScreen: boolean)`	Controlador que se registra cuando el usuario alterna la vista de pantalla completa o ventana de una pestaña.	function boolean
`microsoftTeams.registerChangeSettingsHandler()`	Controlador que se registra cuando el usuario selecciona el botón Configuración habilitado para volver a configurar una pestaña.	function
`microsoftTeams.getTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters,)`	Obtiene las pestañas propiedad de la aplicación. La devolución de llamada recupera el objeto TabInformation. El objeto TabInstanceParameters es un parámetro opcional.	function tabInfo obj
`microsoftTeams.getMruTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters)`	Obtiene las pestañas usadas más recientemente para el usuario. La devolución de llamada recupera el objeto TabInformation. El objeto TabInstanceParameters es un parámetro opcional.	function tabInfo obj tabInstance obj
`microsoftTeams.shareDeepLink(deepLinkParameters: DeepLinkParameters)`	Toma el objeto DeepLinkParameters como entrada y comparte un cuadro de diálogo de vínculo profundo que un usuario puede usar para navegar al contenido dentro de la pestaña.	function deepLink obj
`microsoftTeams.executeDeepLink(deepLink: string, onComplete?: (status: boolean, reason?: string))`	Toma un deepLink necesario como entrada y navega al usuario a una dirección URL o desencadena una acción de cliente(como abrir o instalar) una aplicación dentro de Teams.	function
`microsoftTeams.navigateToTab(tabInstance: TabInstance, onComplete?: (status: boolean, reason?: string))`	Toma el objeto TabInstance como entrada y navega a una instancia de pestaña especificada.	function tabInstance obj

Espacio de nombres de autenticación

Función	Descripción	Documentación
`microsoftTeams.authentication.authenticate(authenticateParameters?: AuthenticateParameters)`	Inicia una solicitud de autenticación que abre una nueva ventana con los parámetros proporcionados por el autor de la llamada. El objeto AuthenticateParameters define los valores de entrada opcionales.	function auth obj
`microsoftTeams.authentication.notifySuccess(result?: string, callbackUrl?: string)`	Notifica al marco que inició la solicitud de autenticación que la solicitud se ha realizado correctamente y cierra la ventana de autenticación	function
`microsoftTeams.authentication.notifyFailure(reason?: string, callbackUrl?: string)`	Notifica al marco que inició la solicitud de autenticación que la solicitud ha producido un error y cierra la ventana de autenticación.	function
`microsoftTeams.authentication.getAuthToken(authTokenRequest: AuthTokenRequest)`	Enviar solicitud para emitir Azure AD token en nombre de la aplicación. El token se puede adquirir de la memoria caché, si no ha expirado. De lo contrario, se envía una solicitud Azure AD para obtener un nuevo token.	function

Configuración espacio de nombres

Función	Descripción	Documentación
`microsoftTeams.settings.setValidityState(validityState: boolean)`	El valor inicial es false. Activa el botón Guardar o Quitar cuando el estado de validez es true.	function
`microsoftTeams.settings.getSettings(callback: (instanceSettings: Settings)`	Obtiene la configuración de la instancia actual. La devolución de llamada recupera el Configuración objeto.	function settings obj
`microsoftTeams.settings.setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string)`	Configura la configuración de la instancia actual. La configuración válida se define mediante Configuración objeto.	function settings obj
`microsoftTeams.settings.registerOnSaveHandler(handler: (evt: SaveEvent)`	Controlador que se registra cuando el usuario selecciona el botón Guardar. Este controlador debe usarse para crear o actualizar el recurso subyacente que potencia el contenido.	function
`microsoftTeams.settings.registerOnRemoveHandler(handler: (evt: RemoveEvent)`	Controlador que se registra cuando el usuario selecciona el botón Quitar. Este controlador debe usarse para quitar el recurso subyacente que potencia el contenido.	function

Espacio de nombres de módulos de tareas

Función	Descripción	Documentación
`microsoftTeams.tasks.startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string)`	Toma el objeto TaskInfo como entrada y permite que una aplicación abra el módulo de tareas. El objeto submitHandler opcional se registra cuando se completa el módulo de tareas.	function taskInfo obj
`microsoftTeams.tasks.submitTask(result?: string \| object, appIds?: string \| string[])`	Envía el módulo de tareas. El parámetro de cadena de resultado opcional es el resultado enviado al bot o a la aplicación y suele ser un objeto JSON o serialización; El parámetro de cadena o matriz de cadena appIds opcional ayuda a validar que la llamada se originó desde el mismo appId que el que invocó el módulo de tareas.	function