Documentación / Integraciones y creación de contenido / Controlar las capas del sistema desde su sitio web

Controlar las capas del sistema desde su sitio web

Introducción y orientación

Conecte los botones de su sitio web con la navegación entre las capas del sistema.

Cuándo utilizar estas funciones

Estas funciones JavaScript están disponibles para su sitio cuando se abre en el dispositivo mediante la aplicación Sitio web. El desarrollador de su sitio, o usted si lo desarrolla, puede conectarlas con botones propios de la página para que los visitantes abran el menú de aplicaciones o pasen a reproducir campañas.

Resulta útil para mostrar la web a pantalla completa sin los controles del sistema e integrar la navegación entre capas en su propio diseño. El ejemplo muestra un plano como aplicación predeterminada junto con un menú de otras aplicaciones.

Botones propios en un sitio web integrado

1 — Menú: un botón propio abre el menú de la capa de aplicaciones para que los visitantes salgan del plano y elijan otra aplicación. showLayerBottom

2 — Anuncios: un botón propio cambia a la capa de presentación con las campañas. showLayerTop

Ilustración localizada a partir de la captura facilitada. Los textos del menú instalado pueden variar.

Los nombres y el aspecto de los botones son ejemplos. El desarrollador o proveedor los añade al sitio integrado. Para los detalles de implementación, consulte las funciones de navegación y los ejemplos de código siguientes.

Abrir el menú requiere más de una aplicación disponible en ese momento; cambiar a anuncios requiere habilitar la capa de presentación. Pruebe siempre la navegación prevista en el dispositivo de destino.

A quién va dirigida esta guía y responsabilidades

  • El proveedor de la plataforma proporciona las funciones de navegación del reproductor y documenta cómo utilizarlas.
  • El cliente selecciona el sitio mostrado en la Sitio web y acuerda los controles necesarios con su proveedor.
  • El proveedor o desarrollador del sitio integrado modifica la propia web, por ejemplo añadiendo botones y conectándolos con las funciones aquí descritas. Las instrucciones técnicas y los ejemplos de código de esta guía están destinados a ese proveedor o desarrollador. Si desarrolla la web usted mismo, también asume esta función.

Referencia técnica

Guía técnica para desarrolladores web

Conecte sus botones con las funciones de navegación del sistema. Empiece por las convenciones comunes de llamada y continúe con las funciones y los ejemplos.

El reproductor ofrece estas funciones a una web abierta en la aplicación Sitio web. Compruebe que la función está disponible antes de llamarla, como muestran los ejemplos siguientes.

Convenciones comunes de llamada

  • Solicitud: request es una cadena que contiene un objeto JSON vacío. Utilice request: '{}', no el objeto {} en sí.
  • Éxito: onSuccess confirma que se ha aceptado la solicitud, no que la navegación haya terminado ni que una campaña concreta sea visible. La respuesta no contiene datos de la aplicación; no base decisiones en el valor de response.
  • Fallo: gestione onFailure(error_code, error_message). Las solicitudes rechazadas descritas abajo devuelven el código -1. Los mensajes de error son valores exactos de la interfaz y no deben traducirse.

onUp

Solicita volver mediante la navegación del sistema. El destino depende del modo de la aplicación web y de la ruta disponible. No vuelve a la URL anterior del historial del navegador ni equivale a window.history.back(). Si no es posible volver, la función comunica el error siguiente.

if (typeof window.onUp !== 'function') {
    console.warn("La función de navegación del reproductor no está disponible.");
} else {
    window.onUp({
        request: '{}',
        onSuccess: function () {
            console.log("Se ha aceptado la solicitud de navegación.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Error: error_code -1, Disabled bottom layer. Single-app kiosk.

showLayerBottom

Solicita el menú de la capa de aplicaciones. Debe haber más de un elemento disponible en la lista, teniendo en cuenta su vigencia programada. Si solo hay uno o ninguno, la función comunica el error siguiente.

if (typeof window.showLayerBottom !== 'function') {
    console.warn("La función de navegación del reproductor no está disponible.");
} else {
    window.showLayerBottom({
        request: '{}',
        onSuccess: function () {
            console.log("Se ha aceptado la solicitud de navegación.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Error: error_code -1, Single-app kiosk.

showLayerTop

Solicita la capa de presentación. Debe estar habilitada en la configuración del dispositivo; de lo contrario, la función comunica el error siguiente. Aceptar la solicitud no confirma que se haya reproducido una campaña concreta ni que su contenido esté disponible.

if (typeof window.showLayerTop !== 'function') {
    console.warn("La función de navegación del reproductor no está disponible.");
} else {
    window.showLayerTop({
        request: '{}',
        onSuccess: function () {
            console.log("Se ha aceptado la solicitud de navegación.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Error: error_code -1, Top layer disabled.

Indicaciones de implementación

Utilice onUp para volver según el contexto de navegación, showLayerBottom para el menú de aplicaciones y showLayerTop para contenido de presentación. Evite llamadas repetidas rápidamente, por ejemplo por varias pulsaciones. Llamar a una función ausente provoca un error de JavaScript antes de que onFailure pueda ejecutarse, por lo que los ejemplos comprueban primero la disponibilidad.

¿No ha encontrado lo que buscaba?
Póngase en contacto con su proveedor de software.