systemtime

8 min

El objeto hora del sistema proporciona la capacidad de leer y escribir la hora almacenada en el reloj en tiempo real (RTC). También se puede usar para leer y escribir la configuración de la zona horaria.

IDL de systemtime

interface SystemTime {
    Promise<void> setDate(Date date);
    Promise<void> setTimeZone(String timezone_string); // requires reboot
    Promise<String> getTimeZone();
    Promise<LastNetworkTimeResult> lastNetworkTimeResult();
    void addEventListener(String type, NetworkTimeEventCallback callback);
    void removeEventListener(String type, NetworkTimeEventCallback callback);
};

interface LastNetworkTimeResult {
    readonly attribute long successTimestamp;
    readonly attribute long attemptTimestamp;
    readonly attribute String failureReason;
};

Creación de objetos

Para crear un objeto systemtime , primero cargue el módulo brightsign/systemtime usando el método require() . Luego cree una instancia de la clase systemtime .

var systemTimeClass = require("@brightsign/systemtime");
var systemTime = new systemTimeClass();

SystemTime

Utilice esta interfaz para configurar la fecha y la zona horaria y recuperar datos de hora de red.

Eventos

[EventHandler] evento de tiempo de red: Un evento que se genera cuando el reproductor intenta actualizar su reloj a través de la red. Use el método addEventListener() para escuchar este evento. Los resultados se devuelven como una interfaz Evento de tiempo de red .

Métodos

setDate()

Promise<void> setDate(Date date)

Especifica una nueva hora para el RTC usando la zona horaria actual.

setTimeZone()

Promise<void> setTimeZone(String timezone_string)

Especifica una nueva configuración de zona horaria para el reproductor (las zonas horarias compatibles se enumeran en esta página). Como alternativa, se puede aplicar una zona horaria con formato POSIX agregando un valor POSIX: al comienzo de la cadena. Este método requiere un reinicio para entrar en vigor.

getTimeZone() Como Promise<String>

Promise<String> getTimeZone()

Devuelve la configuración actual de la zona horaria del reproductor. Se agrega un valor POSIX: al comienzo de la cadena si la zona horaria se ha configurado usando el formato POSIX.

lastNetworkTimeResult()

Promise<LastNetworkTimeResult> lastNetworkTimeResult()

Devuelve una interfaz LastNetworkTimeResult que contiene información sobre el último intento de establecer la hora a través de la red.

LastNetworkTimeResult

Esta interfaz contiene información sobre el último intento de establecer la hora a través de la red. Contiene los siguientes atributos de solo lectura:

successTimestamp long: Un valor que indica cuándo (en segundos) se configuró correctamente el reloj por última vez a través de la red. Este valor es cero si el reloj nunca se ha configurado correctamente a través de la red.

attemptTimestamp long: Un valor que indica cuándo (en segundos) se realizó el último intento de configurar el reloj a través de la red. Este valor es cero si todavía no se ha realizado ningún intento.

failureReason String: Si el último intento de configurar el reloj a través de la red falló, esta cadena contendrá un mensaje de error. Si el último intento fue exitoso, esta cadena estará vacía.

NetworkTimeEvent

Esta interfaz es devuelta por el detector de eventos para networktimeevent. Contiene los siguientes atributos de solo lectura:

éxito bool: Un indicador que señala si el último intento de establecer la hora a través de la red tuvo éxito o no.

razón string: Un mensaje de error que se incluirá si el último intento falló.

Ejemplo

var SystemTimeClass = require("@brightsign/systemtime");
var systemTime = new SystemTimeClass();

//Set the date to 2018
var date = new Date();
date.setFullYear(2018);
systemTime.setDate(date);

//Set the time zone
systemTime.setTimeZone("PST")

//Listen for a network time event
systemTime.addEventListener("networktimeevent",
    function(data) {
        console.log("Last network update:" + JSON.stringify(data.detail));
    });