EloView Home SDK 6.23.14

Plataformas compatibles: Dispositivos Elo Android 12 y Android 14 incluyendo Backpack 4 (Estándar/Valor), I-Series 4 (Estándar/Valor), I-Series Estándar, M50, M60 Pay, M100 y 7-Inch Pay.

Referencia Completa (Base de Conocimientos + Javadoc del SDK)

Las API están organizadas por clase funcional (Sistema, Red, Paquete, etc.) para simplificar el descubrimiento y acelerar la implementación.

---

Mejores Prácticas Globales (de KB)

1. Siempre vincule al servicio antes de llamar a cualquier API.
   No invoque los métodos hasta que onServiceConnected() sea recibido.

2. Suponga que la política del dispositivo puede anular la configuración local.
   Esto es especialmente cierto para la hora, la zona horaria, USB, modo quiosco e instalación de aplicaciones.

3. Utilice NTP para la sincronización de hora en producción.
   Evite la configuración manual de hora excepto para pruebas.

4. Entienda el comportamiento de reinicio.

   • Reinicio Empresarial borra la configuración Elo y el estado de inscripción.

   • Reinicio de Fábrica borra todos los datos de usuario y devuelve el dispositivo al estado fuera de la caja.

5. Registre el resultado de cada llamada a la API.
   Esto es crítico para la solución de problemas y escalamiento.

---

Escenarios Comunes del Mundo Real (de KB)

Escenario: Zona horaria incorrecta después de la inscripción del dispositivo

system.setNtpEnabled(true);
system.setNtpServer("time.aws.com");
system.setTimeZone("US/Central");
system.syncTimeNow();

// Verificar
String tz = system.getTimeZone();
Log.d(TAG, "Timezone=" + tz);

Consejo: Si la zona horaria vuelve a revertir después de reiniciar, verifique que la zona horaria automática de Android esté habilitada y que la política del dispositivo no esté reaplicando una región diferente.

Escenario: Configurar de manera segura el modo quiosco de aplicación única

pkg.setKioskApp("com.example.kiosk");
pkg.setKioskModeEnabled(true);
pkg.launchApp("com.example.kiosk");

Advertencia: Siempre valide una ruta de escape administrativa antes de habilitar el modo quiosco en producción.

Plantilla de Vinculación de Servicio (de KB)

eloView.bindService(context, callback, accessToken);
// Seguro llamar a APIs de SDK dentro de callback.onServiceConnected()
eloView.unbindService(context);

Nota importante: bindService() y unbindService() no devuelven valores. Las APIs de SDK solo deben invocarse después de que se llame a onServiceConnected().

API de Núcleo / Vinculación de Servicio

EloView

La clase EloView proporciona las siguientes operaciones:

• Establezca el contenido que se reproducirá en el dispositivo en modo Control de Elo cuando el dispositivo esté fuera de línea o no esté registrado en una cuenta utilizando setOfflinePlayContent().
• Recupere el tipo de contenido (APK o WebView) y el nombre del contenido actualmente establecido en modo Control de Elo utilizando getPlayContent().
• Obtenga el estado de reproducción actual del contenido configurado en modo Control de Elo utilizando getPlayContentStatus().
• Verifique si el dispositivo está actualmente conectado a EloView Cloud (en línea o fuera de línea) utilizando getDeviceCloudStatus().
• Alternar Wi-Fi en Configuración Rápida de Elo y Modo Android Home utilizando toggleWifi().
• Alternar Bluetooth en Configuración Rápida de Elo y Modo Android Home utilizando toggleBT().

bindService

public void bindService(android.content.Context context, ServiceConnectionCallback callback, java.lang.String accessToken)

Este método vincula el servicio EloView a la aplicación. Debe llamar a esto antes de invocar cualquier API de EloView.

Parámetros

• context – Contexto en el que se utilizan las APIs de EloView.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.bindService(context, callback, "accessToken");
    Log.d(TAG, "OK: resultado de bindService=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: bindService", e);
}

unbindService

public void unbindService(android.content.Context context)

Este método se utiliza para desvincular el servicio de la aplicación. Utilice este método para desvincular el servicio de la aplicación al limpiar recursos.

Parámetros

• context – Contexto

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.unbindService(context);
    Log.d(TAG, "OK: resultado de unbindService=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: unbindService", e);
}

setOfflinePlayContent

public java.lang.String setOfflinePlayContent(java.lang.String packageName)

Este método se utiliza para establecer contenido en el dispositivo en modo Control de Elo cuando el dispositivo está fuera de línea o no registrado en una cuenta. Si el dispositivo vuelve a estar en línea y se establece contenido a través de EloView, este reemplazará el contenido establecido a través de esta API.

Parámetros

• packageName – Paquete que se establecerá como contenido predeterminado en el dispositivo.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.setOfflinePlayContent("packageName");
    Log.d(TAG, "OK: resultado de setOfflinePlayContent=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: setOfflinePlayContent", e);
}

getPlayContent

public java.lang.String getPlayContent()

Este método devuelve el tipo de contenido y el nombre del contenido establecido en el dispositivo. Este método solo funciona en modo Control de Elo.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getPlayContent();
    Log.d(TAG, "OK: resultado de getPlayContent=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getPlayContent", e);
}

getPlayContentStatus

public java.lang.String getPlayContentStatus()

Este método devuelve el estado del contenido de reproducción en el dispositivo en modo Control. El estado puede ser uno de los siguientes strings:

YET_TO_DOWNLOAD, DOWNLOADING, DOWNLOADED, INSTALLING, INSTALLED, DOWNLOAD_FAILED, INSTALL_FAILED, UNKNOWN_STATUS

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getPlayContentStatus();
    Log.d(TAG, "OK: resultado de getPlayContentStatus=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getPlayContentStatus", e);
}

getDeviceCloudStatus

public java.lang.String getDeviceCloudStatus()

Este método devuelve el estado en línea o fuera de línea del dispositivo. El estado puede ser uno de los siguientes strings: "En línea", "Fuera de línea", "Conectando", "Reconectando", "En línea (No aprovisionado)".

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getDeviceCloudStatus();
    Log.d(TAG, "OK: resultado de getDeviceCloudStatus=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getDeviceCloudStatus", e);
}

toggleWifi

void toggleWifi(boolean isEnableWifi)

Este método habilita o deshabilita Wi-Fi en el dispositivo. Esto se aplica tanto en modo EloView como en modo Android Home.

Parámetros

• isEnableWifi – Booleano para habilitar o deshabilitar Wi-Fi en Configuración Rápida.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.toggleWifi(true);
    Log.d(TAG, "OK: resultado de toggleWifi=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: toggleWifi", e);
}

switchToAndroidHomeMode

void switchToAndroidHomeMode() void switchToAndroidHomeMode(boolean isRebootNeeded, boolean isAndroidHomeMode)

Este método se utiliza para cambiar al modo Android Home desde el modo EloView. Esto es lo mismo que switchToAndroidHomeMode() excepto que acepta dos parámetros booleanos. No hay forma de volver a modo EloView sin un reinicio de fábrica, así que use con precaución.

Parámetros

• Cambia el dispositivo de modo EloView a modo Android Home.
• Si isRebootNeeded se establece en true, el dispositivo se reiniciará para aplicar el cambio de modo.
• Nota importante: Cambiar al modo Android Home puede desactivar las restricciones y políticas gestionadas por EloView.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.switchToAndroidHomeMode(true, true);
    Log.d(TAG, "OK: resultado de switchToAndroidHomeMode=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: switchToAndroidHomeMode", e);
}

toggleBT

public int toggleBT(boolean isEnableBT)

Este método se utiliza para alternar Bluetooth en Configuración Rápida (modo EloView). También se puede utilizar para alternar Bluetooth en modo Android Home.

Parámetros

• isEnableBT – Booleano para habilitar o deshabilitar Bluetooth en Configuración Rápida.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.toggleBT(true);
    Log.d(TAG, "OK: resultado de toggleBT=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: toggleBT", e);
}

API de Cuentas

AccountManager

La clase AccountManager proporciona las siguientes operaciones:

1. Proporcionar un Token de Autenticación de un EloServer basado en las credenciales proporcionadas por el usuario (ID de correo/contraseña o clientId/secretKey).

2. Verificar si un Token de Autenticación dado es válido o ha expirado. El token de autenticación puede ser el token obtenido del servidor EloView o puede ser un token JWT fuera de línea proporcionado por el equipo de soporte de Elo. (El token fuera de línea se genera utilizando el nombre del paquete de su aplicación y solo se puede usar con el paquete para el que se generó).

3. Todas las API requieren un token fuera de línea para funcionar y no funcionarán con un token en línea. La única excepción son las APIs OTA. Las APIs OTA requieren el token en línea al aplicar la OTA desde un servidor EloView. Para aplicar OTA a través de una URL de servidor personalizado o desde un archivo local en el dispositivo, se puede usar el token fuera de línea.

Por ejemplo, para obtener un Token de Autenticación:

1. Utilizando ID de correo y contraseña, llame a getEloAccessToken. 2. Utilizando clientId y secretKey, llame a getEloOAuthToken. Tras la autenticación exitosa, estos métodos devolverán un token. 3. Para el token JWT fuera de línea, contacte al equipo de soporte de Elo.

El token recuperado del servidor o del equipo de soporte se verifica utilizando el método verifyEloToken.

Desregístrese de los receptores de difusión utilizados por estas API de AccountManager utilizando el método unregisterAccountManagerListener en los métodos onPause y onDestroy de las actividades en las que utiliza estas API para evitar fugas.

getProperty

public static java.lang.String getProperty()

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getProperty();
    Log.d(TAG, "OK: resultado de getProperty=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getProperty", e);
}

setProperty

public void setProperty(java.lang.String property)

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.setProperty("property");
    Log.d(TAG, "OK: resultado de setProperty=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: setProperty", e);
}

getClientId

public static java.lang.String getClientId()

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getClientId();
    Log.d(TAG, "OK: resultado de getClientId=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getClientId", e);
}

getBaseUri

public static android.net.Uri getBaseUri()

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getBaseUri();
    Log.d(TAG, "OK: resultado de getBaseUri=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getBaseUri", e);
}

getEloAccessToken

public void getEloAccessToken(android.content.Context context, java.lang.String userEmail, java.lang.String password, android.os.Handler handler)

Este método se utiliza para obtener un token de acceso del servidor Elo.

Parámetros

• context – Un objeto de contexto de la clase que llama (Actividad o Servicio).

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getEloAccessToken(context, "userEmail", "password", handler);
    Log.d(TAG, "OK: resultado de getEloAccessToken=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getEloAccessToken", e);
}

configureOAuthHostedUI

public void configureOAuthHostedUI(android.app.Activity activity, android.os.Handler handler)

Este método se utiliza para inicializar la Interfaz de Usuario Alojada OAuth.

Parámetros

• activity – Una instancia de Actividad de la clase que llama.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.configureOAuthHostedUI(activity, handler);
    Log.d(TAG, "OK: resultado de configureOAuthHostedUI=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: configureOAuthHostedUI", e);
}

stopOAuth

public void stopOAuth()

Llame a stopOAuth en el método onStop() sobrescrito de la actividad.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.stopOAuth();
    Log.d(TAG, "OK: resultado de stopOAuth=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: stopOAuth", e);
}

destroyOAuth

public void destroyOAuth()

Llame a destroyOAuth en el método onStop() sobrescrito de la actividad.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.destroyOAuth();
    Log.d(TAG, "OK: resultado de destroyOAuth=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: destroyOAuth", e);
}

logoutOAuth

public void logoutOAuth()

Llame a logoutOAuth para finalizar la sesión de inicio actual.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.logoutOAuth();
    Log.d(TAG, "OK: resultado de logoutOAuth=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: logoutOAuth", e);
}

verifyEloToken

public void verifyEloToken(android.content.Context context, java.lang.String accessToken, android.os.Handler handler)

Esta función pide al servidor Elo que verifique el token dado. Tras la verificación exitosa, el manejador recibirá un mensaje de tipo TOKEN_VERIFY_SUCCESS. En caso de fallo, se recibirá TOKEN_VERIFY_FAIL.

Parámetros

• context – Un objeto de contexto de la clase que llama (Actividad o Servicio).

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.verifyEloToken(context, "accessToken", handler);
    Log.d(TAG, "OK: resultado de verifyEloToken=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: verifyEloToken", e);
}

getEloOAuthToken

public void getEloOAuthToken(android.content.Context context, java.lang.String clientID, java.lang.String secret, android.os.Handler handler)

Este método se utiliza para solicitar al Portal EloView un nuevo token OAuth. Tras la autenticación exitosa, se enviará un token al dispositivo. Este token es válido para su uso durante 24 horas después de ser emitido. Cuando el token expira, los intentos posteriores de verificar el token y llamar a APIs recibirán la respuesta TOKEN_VERIFY_FAIL. Lo mismo ocurre si nunca se obtuvo o recibió un token.

Si tiene éxito, el controlador recibirá un mensaje de tipo OAUTH_TOKEN_VALID con un token JWT como respuesta. A continuación se muestra un ejemplo de una respuesta exitosa:

En caso de un fallo de autenticación debido a un mal clientID o secretID, el controlador recibirá un mensaje de tipo OAUTH_TOKEN_INVALID.

Parámetros

• context – Un objeto de contexto de la clase que llama (Actividad o Servicio).

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getEloOAuthToken(context, "clientID", "secret", handler);
    Log.d(TAG, "OK: resultado de getEloOAuthToken=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getEloOAuthToken", e);
}

unregisterAccountManagerListener

public void unregisterAccountManagerListener(android.content.Context context)

Este método se utiliza para desregistrar el receptor de difusión registrado mientras utiliza cualquiera de las API de AccountManager. Asegúrese de llamar a esto en los métodos onPause y onDestroy de su actividad si utilizó alguna de las API de AccountManager. Esto asegura que el receptor no se fuga.

Parámetros

• context – Contexto en el que se utilizaron las APIs del sistema.
• context – Contexto de Android utilizado para desregistrar el oyente del administrador de cuentas.

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.unregisterAccountManagerListener(context);
    Log.d(TAG, "OK: resultado de unregisterAccountManagerListener=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: unregisterAccountManagerListener", e);
}

setDefaultEnvironment

public void setDefaultEnvironment(android.content.Context ctx)

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.setDefaultEnvironment(context);
    Log.d(TAG, "OK: resultado de setDefaultEnvironment=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: setDefaultEnvironment", e);
}

selectEnvironment

public void selectEnvironment(android.content.Context ctx, java.lang.String prop, boolean isSealed)

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.selectEnvironment(context, "prop", true);
    Log.d(TAG, "OK: resultado de selectEnvironment=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: selectEnvironment", e);
}

isPolarisLocked

public boolean isPolarisLocked(android.content.Context context)

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.isPolarisLocked(context);
    Log.d(TAG, "OK: resultado de isPolarisLocked=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: isPolarisLocked", e);
}

getEnvironment

public java.lang.String getEnvironment(android.content.Context ctx)

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getEnvironment(context);
    Log.d(TAG, "OK: resultado de getEnvironment=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getEnvironment", e);
}

getDeviceCloudStatus

public java.lang.String getDeviceCloudStatus()

Ejemplo

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getDeviceCloudStatus();
    Log.d(TAG, "OK: resultado de getDeviceCloudStatus=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getDeviceCloudStatus", e);
}

getGpsEnabled

public boolean getGpsEnabled()

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getGpsEnabled();
    Log.d(TAG, "OK: resultado de getGpsEnabled=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getGpsEnabled", e);
}

getBatteryLevel

public java.lang.String getBatteryLevel()

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getBatteryLevel();
    Log.d(TAG, "OK: resultado de getBatteryLevel=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getBatteryLevel", e);
}

getPowerStatus

public java.lang.String getPowerStatus()

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getPowerStatus();
    Log.d(TAG, "OK: resultado de getPowerStatus=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getPowerStatus", e);
}

getModelNameEnabled

public boolean getModelNameEnabled()

try {
    // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
    Object result = sdk.getModelNameEnabled();
    Log.d(TAG, "OK: resultado de getModelNameEnabled=" + result);
} catch (Exception e) {
    Log.e(TAG, "FALLA: getModelNameEnabled", e);
}

Constantes APIs

Consts

Proporciona métodos auxiliares para la identificación del dispositivo, comprobaciones de estado de migración y creación de intenciones específicas de Elo.

---

isDevice7Inch

public static boolean isDevice7Inch()

Ejemplo

try {
  // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
  Object result = sdk.isDevice7Inch();
  Log.d(TAG, "OK: resultado de isDevice7Inch=" + result);
} catch (Exception e) {
  Log.e(TAG, "FALLA: isDevice7Inch", e);
}

---

isDeviceM100

public static boolean isDeviceM100()

Ejemplo

try {
  // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
  Object result = sdk.isDeviceM100();
  Log.d(TAG, "OK: resultado de isDeviceM100=" + result);
} catch (Exception e) {
  Log.e(TAG, "FALLA: isDeviceM100", e);
}

---

getMigrate

public org.json.JSONObject getMigrate(android.content.Context context)

Ejemplo

try {
  // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
  Object result = sdk.getMigrate(context);
  Log.d(TAG, "OK: resultado de getMigrate=" + result);
} catch (Exception e) {
  Log.e(TAG, "FALLA: getMigrate", e);
}

---

getEloIntentWithFlag

public android.content.Intent getEloIntentWithFlag(android.content.Context context, java.lang.String token, java.lang.String action)

Ejemplo

try {
  // TODO: asegurar que el servicio esté vinculado antes de llamar a las APIs del SDK
  Object result = sdk.getEloIntentWithFlag(context, "token", "action");
  Log.d(TAG, "OK: resultado de getEloIntentWithFlag=" + result);
} catch (Exception e) {
  Log.e(TAG, "FALLA: getEloIntentWithFlag", e);
}