Suspensión de la aplicación para la aplicación de pestaña

Cuando un usuario se aleja de una aplicación, esta puede suspenderse o finalizarse. La suspensión significa que la aplicación está en segundo plano y no es visible para el usuario. La terminación significa que la aplicación se cierra completamente y se elimina de la memoria. La suspensión de una aplicación mejora el tiempo de inicio posterior de las aplicaciones dentro de Teams u otros productos de Microsoft 365, ya que le permite mantener algunos recursos y activos en memoria que puede usar al rehidratar su aplicación.

Anteriormente, la suspensión de aplicaciones se conocía como una aplicación en caché y solo era compatible en Teams, pero ahora es compatible con las aplicaciones de Teams ampliadas para ejecutarse también en otras aplicaciones de Microsoft 365.

En Teams, se admite la suspensión de aplicaciones para los siguientes ámbitos y clientes:

Ámbito   Escritorio iOS Android
Personal ✔️ Duración de la memoria caché: 30 minutos ✔️ ❌
Chat ✔️ Duración de la memoria caché: 30 minutos ✔️ ❌
Canal ✔️ Duración de la memoria caché: 30 minutos ✔️ ❌
Pestaña Reunión ✔️ Duración de la memoria caché: 30 minutos ✔️ ❌
Panel lateral de reunión o aplicaciones dentro de la reunión ✔️ Duración de la memoria caché: 20 minutos ❌ ❌

Habilitar suspensión de aplicaciones

Para habilitar la suspensión de la aplicación, siga estos pasos:

  1. Llame a las API app.lifeCycle.registerBeforeSuspendOrTerminate y app.lifeCycle.registerOnResumeHandler . Estos controladores son necesarios para habilitar la suspensión de aplicaciones. Para obtener más información, consulte el módulo de ciclo de vida disponible en la referencia de TeamsJS.

    El app.lifecycle.registerBeforeSuspendOrTerminate controlador le brinda la oportunidad de realizar algunas tareas antes de que su aplicación se suspenda o finalice, mientras que se app.lifecycle.registerOnResumeHandler llama cuando un usuario navega de regreso a su aplicación.

    El registro de ambos controladores habilita una aplicación para la suspensión de la aplicación, pero es importante comprender que estar registrado no garantiza que la aplicación no se finalice en segundo plano. La finalización de una aplicación depende de otros factores, como la memoria disponible.

    Nota:

    Anteriormente teamsCore.registerBeforeUnloadHandler y teamsCore.registerOnLoadHandler se usaban para habilitar el almacenamiento en caché de aplicaciones, pero ahora están en desuso.

  2. Use contentUrl y entityId pase al controlador de currículum vítae para enrutar a la página correcta dentro de la aplicación e invocar notifySuccess o notifyFailure notificar al host que el flujo de inicialización de la aplicación se ha completado.

    • contentUrl: Agregar dirección URL de página de contenido.
    • entityId: agregue un identificador único.
  3. Elimine los recursos y realice la limpieza necesaria en el beforeSuspendOrTerminate controlador.

El siguiente diagrama de flujo muestra el primer inicio de una aplicación que quiere participar en la suspensión de la aplicación (registre los resume controladores or beforeSuspensionOrTerminate en el primer inicio de la aplicación):

Captura de pantalla que muestra el flujo del primer inicio de la aplicación en el panel lateral de la reunión.

El siguiente diagrama de flujo muestra el inicio de aplicaciones suspendidas:

La captura de pantalla muestra el flujo del inicio suspendido de la aplicación en el panel lateral de la reunión.

Cuando opta por la suspensión de la aplicación, el iframe o vista web que se usa para hospedar la aplicación incrustada se reutiliza a medida que los usuarios navegan a diferentes instancias de la aplicación dentro de una ventana. El iframe o vista web usado para hospedar la aplicación se oculta cuando los usuarios abandonan la aplicación y se muestra cuando los usuarios vuelven a ella.

Nota:

Si la suspensión de aplicaciones no está habilitada, el iframe o vista web se vuelve a crear cada vez que el usuario inicia la aplicación.

Hay varias razones para que una aplicación no se suspenda o para que una aplicación se quite de la memoria caché. Algunas razones generales en las aplicaciones de Microsoft 365 son:

  • La carga total de memoria es alta.
  • El número total de aplicaciones suspendidas supera el tamaño máximo de caché. En esta circunstancia, se quitará la aplicación suspendida más antigua.
  • La aplicación finaliza si la memoria disponible del equipo es insuficiente.
  • La aplicación se suspende durante mucho tiempo sin reanudarse.
  • La aplicación no se carga y se termina.

Dentro de la aplicación Teams, algunos de los motivos son (los números aquí están sujetos a cambios):

  • Si la carga de memoria del sistema es alta, la aplicación se quita de la memoria caché.
  • La aplicación finaliza si Teams no recibe la señal de TeamsJS en un readyToUnload plazo de 30 segundos después de enviar la beforeUnload notificación.
  • La suspensión de aplicaciones se deshabilita si la memoria del sistema es inferior a 4 GB o si la memoria disponible es inferior a 1 GB en Windows o 512 MB en Mac.
  • El panel lateral es el único frameContext admitido para la suspensión de aplicaciones en reuniones.
  • La suspensión de aplicaciones no se admite para las reuniones en las que el número de usuarios invitados es superior a 20.
  • En iOS, cuando la aplicación Teams finaliza, la aplicación se quita de la memoria caché.

Ejemplo de código

El siguiente fragmento de código es un ejemplo de app.lifecycle.registerOnResumeHandler y app.lifecycle.registerBeforeSuspendOrTerminateHandler API:

MicrosoftTeams.app.lifecycle.registerOnResumeHandler((data) => {  

   console.log("got resume call" , data.contentUrl, data.entityId);  

   // use contentUrl to route to correct page  
   // invoke notifySuccess when ready  

   app.notifySuccess();  

}); 

MicrosoftTeams.app.lifecycle.registerBeforeSuspendOrTerminateHandler(() => {  

   // dispose resources and resolve promise 

}); 

Nota:

Anteriormente, las API del módulo se usaban para habilitar el almacenamiento en caché de teamsCore aplicaciones. Si una aplicación se registra para ambos app.lifecycle y teamsCore pares de controladores, los app.lifecycle controladores sobrescriben los teamsCore controladores.

Herramienta de depuración para aplicaciones en caché

Nota:

La herramienta de depuración para aplicaciones en caché está disponible en versión preliminar pública para desarrolladores para aplicaciones de Teams.

Puede habilitar Proto Task Manager en Teams, una herramienta de depuración que muestra el estado de las aplicaciones almacenadas en caché. En su cliente de Teams, seleccione las teclas Control+Mayús+Alt+8 en Windows o Comando+Mayús+Opción+8 en Mac para abrir el Administrador de tareas Proto.

La captura de pantalla muestra la pestaña de almacenamiento en caché en el Administrador de tareas Proto en Teams.

La pestaña AppCaching contiene los siguientes detalles:

  • state: muestra el estado de la aplicación en caché o sin caché.
  • isActive: muestra el estado activo o inactivo de la aplicación en caché.
  • timeElapsed: muestra el tiempo transcurrido desde que la aplicación fue almacenada en caché.
  • supportsLoad: muestra si la aplicación registró el controlador si el almacenamiento en caché de la Load aplicación está habilitado.
  • supportsBeforeUnload: muestra si la aplicación registró el controlador si el almacenamiento en caché de la BeforeUnload aplicación está habilitado.
  • totalFrameMemory: muestra el uso de memoria de la aplicación.
  • totalFrameCommitMemory: muestra el uso de CPU de la aplicación.

Aplicaciones de pestañas de precaching

Nota:

El almacenamiento previo en caché de aplicaciones de pestañas solo se admite en clientes web y de escritorio de Teams.

Aunque el almacenamiento en caché reduce los tiempos de carga posteriores de una aplicación, el almacenamiento en caché previo optimiza el tiempo de carga inicial de una aplicación al permitir que Teams precargue la aplicación. Teams precarga las aplicaciones en segundo plano después del inicio o cuando está inactivo, en función de los patrones de uso recientes de las aplicaciones y el historial de caché de las aplicaciones. Las aplicaciones precargadas permanecen almacenadas en caché hasta que el usuario abre la aplicación, lo que da como resultado un tiempo de carga más rápido.

Si habilitas el almacenamiento en caché previo, la aplicación usa recursos y se realiza un seguimiento de los datos de telemetría mientras se encuentra en estado de caché previa. Para obtener información sobre cómo optimizar la aplicación para el almacenamiento en caché previo, consulta procedimientos recomendados.

Habilitar el almacenamiento en caché previo para aplicaciones de pestaña

Para habilitar el almacenamiento en caché previo para la aplicación de pestañas, siga estos pasos:

  1. Habilite el almacenamiento en caché de aplicaciones.

  2. Actualiza el manifiesto de la aplicación de la siguiente manera:

    1. Establezca el valor de showLoadingIndicator en true. Esta acción garantiza que Teams espere hasta que la aplicación se envíe notifySuccess para concluir la secuencia de carga de la aplicación durante el almacenamiento en caché previo. Para obtener más información, vea showLoadingIndicator.

    2. Agregue el backgroundLoadConfiguration objeto y defina el contentUrlarchivo .

      {
      "backgroundLoadConfiguration": {
          "tabConfiguration": {
              "contentUrl": "https://www.contoso.com/content?host=msteams&isBackgroundLoad=true"
              }
          }
      }
      

      Nota:

      • No contentUrl pueden contener parámetros específicos del contexto, como la dirección URL del sitio de grupo o el identificador de subproceso, ya que Teams carga aplicaciones sin contexto previo durante el inicio.
      • Debe contentUrl ser lo suficientemente genérico como para cargarse en segundo plano sin ninguna interacción por parte del usuario.

      Para obtener más información, consulte backgroundLoadConfiguration.

Supervisar la carga en segundo plano

Si supervisa la propiedad, podrá identificar si Teams cargó la aplicación en segundo plano sin interacción del isBackgroundLoad usuario. Si el estado de la propiedad es true, indica que Teams cargó la aplicación en segundo plano y no puede interactuar con el usuario. Por lo tanto, no es necesario que la aplicación represente elementos de la interfaz de usuario, como las solicitudes de inicio de sesión.

Supervise la propiedad en el contexto de la isBackgroundLoad aplicación para optimizar la aplicación para una carga y representación efectivas de precaché. Para obtener más información, vea isBackgroundLoad.

Procedimientos recomendados

A continuación se indican los procedimientos recomendados para la suspensión de aplicaciones y el almacenamiento en caché previo:

  • Se recomienda implementar capacidades de almacenamiento web o trabajo de servicio para almacenar los datos o webview localmente. Esta estrategia ayuda a que la aplicación se cargue más rápido en los inicios posteriores.

  • Registra los controladores de suspensión de la aplicación al principio de la secuencia de inicio, por ejemplo, justo después de llamar app.initialize y antes de que la aplicación envíe notifySuccess. Si el cliente de Teams no ve estos registros antes de que el usuario abandone la aplicación, la aplicación no se almacena en caché.

  • Intente reducir la superficie de memoria cuando se llama al app.lifecycle.onBeforeSuspendOrTerminateHandler controlador y la aplicación está a punto de suspenderse. Por ejemplo, las referencias de versión, quitar eventListeners, pausar las llamadas de sincronización o detener las solicitudes de red.

  • El almacenamiento en caché previo aumenta el tráfico a la aplicación, además de las solicitudes iniciadas por el usuario. Asegúrese de que el punto de conexión que proporcione pueda controlar las contentUrl solicitudes en segundo plano varias veces para cada usuario en un día. Asegúrese de realizar los ajustes de telemetría necesarios para acomodar la carga en segundo plano de la aplicación.

  • Asegúrate de que la aplicación usa menos o igual a 130 MB de memoria en el estado de almacenamiento previo en caché.

Limitaciones generales

Las siguientes son limitaciones generales para la suspensión de aplicaciones:

  • No hay ninguna garantía de que una aplicación se suspenda. Hay razones que pueden llevar a la terminación de la aplicación aunque una aplicación haya registrado los controladores necesarios.

  • Una aplicación se suspende solo cuando el usuario sale de la aplicación. Si una aplicación tiene varias pestañas estáticas, cuando el usuario cambie de pestaña, la pestaña no se suspenderá. El controlador, app.lifecycle.onBeforeSuspendOrTerminate, seguirá siendo llamado.

  • La aplicación suspendida se puede usar dentro de la misma ventana. La aplicación suspendida en una ventana emergente no se puede volver a usar en la ventana principal.

  • Cuando se suspende una aplicación, se eliminan todos los controladores registrados. Cuando se reanuda la aplicación, todos los controladores, como themeChange or focusEnter, deben volver a registrarse. No se envían notificaciones a la aplicación cuando se suspende. Si tu aplicación requiere notificaciones incluso cuando está suspendida, es posible que la suspensión no sea la solución adecuada.

  • Solo las aplicaciones de página única que usan el enrutamiento del lado cliente para la navegación de páginas pueden beneficiarse de la suspensión y reanudación de la aplicación. Se recomienda usar el mismo dominio en todos los contextos de inicio de la aplicación.

  • Se espera que una aplicación entre en suspensión cuando se suspende. No se permiten solicitudes de SDK cuando la aplicación está suspendida.

  • La aplicación host invoca al resume controlador solo después de que se completa la suspendOrTerminate secuencia de la aplicación. Por ejemplo, si un usuario inicia la pestaña A de la aplicación y, a continuación, inicia la pestaña B de la misma aplicación, la pestaña B no recibe la señal hasta que el suspendOrTerminate controlador de la pestaña A haya terminado de resume ejecutarse.

  • El almacenamiento en caché de las aplicaciones se divide por ventana. El almacenamiento en caché de aplicaciones se realiza por aplicación (no por pestaña) dentro de la misma ventana.

  • La tabla de la sección introductoria, Suspensión de aplicaciones para la aplicación de pestaña, proporciona información sobre lo que frameContext Teams admite para el almacenamiento en caché. En el caso de los centros que no son de Teams, solo FrameContext.Content se almacena en caché, lo que significa FrameContext.Task que está dentro Dialog no se admite.

  • Registre solo el controlador si la aplicación no requiere la suspensión de la beforeSuspendOrTerminate aplicación, pero necesita tiempo para guardar el estado de forma segura (ya que salir de la aplicación puede hacer que el contenido de la aplicación se quite abruptamente del modelo de objetos de documento (DOM)). Si la aplicación no se ha registrado para el resume evento, se quita del DOM cuando se completa el suspendOrTerminate flujo.

Limitaciones dentro de Teams

Las siguientes son las limitaciones para la suspensión de aplicaciones dentro de la aplicación Teams:

  • El cliente de Teams invoca al resume controlador solo después de que se completa la suspendOrTerminate secuencia de la aplicación. Por ejemplo, si un usuario inicia la pestaña A de la aplicación y, a continuación, inicia la pestaña B de la misma aplicación, la pestaña B no recibirá la resume señal hasta que el suspendOrTerminate controlador de la pestaña A haya terminado de ejecutarse.

  • La suspensión de aplicaciones no se admite para la fase de reunión o los contextos de diálogo (denominados módulo de tareas en TeamsJS v1.x), ya que se pueden abrir en la parte superior de la pestaña y no se puede usar el mismo iframe o vista web para representar el contenido de la pestaña y el cuadro de diálogo.

  • Siga las directrices de esta sección para incorporar la suspensión de aplicación a aplicación en la reunión de Teams. Para que la suspensión de aplicaciones solo admita en reuniones, registre los resume controladores or beforeSuspendOrTerminate si el contexto es sidePanel.

Solución de problemas

¿Las aplicaciones no se suspenden? ¿Por qué no se invoca el controlador de currículum vítae en la navegación posterior?

  • Compruebe si se cumplen las restricciones del sistema y de la memoria disponible.

  • Reducir la superficie de memoria cuando se almacena en caché. Use el beforeSuspendOrTerminate controlador para eliminar recursos, por ejemplo, liberar referencias y quitar escuchas de eventos que podrían no ser necesarias cuando se almacenan en caché.

Ejemplo de código

Ejemplo de nombre Descripción Node.js
Almacenamiento en caché de aplicaciones En este ejemplo se muestra cómo mejorar los tiempos de carga de las aplicaciones durante las reuniones con almacenamiento en caché del panel lateral, mejorando la experiencia del usuario en Microsoft Teams. Ver

Consulte también