Este documento detalla las interfaces de la API relacionadas con la gestión de dispositivos dentro del módulo outdoor de Ray.

currentDevice

outdoor.currentDevice

Obtiene el identificador del dispositivo que se muestra actualmente en la página principal de la aplicación de desplazamiento.

Requiere importar OutdoorKit, disponible a partir de la versión 1.0.0.

Uso en Ray

// @ray-js/ray >=1.4.40
import { outdoor } from '@ray-js/ray';
const { currentDevice: obtenerDispositivoActual } = outdoor;

Parámetros

Object ocpiones

Parámetros de retorno de object.success

Object respuesta

Parámetros de retorno de object.fail

Object respuesta

Definición de la función (ejemplo)

/**
 * Obtiene el ID del dispositivo principal mostrado en la app de desplazamiento.
 */
export function obtenerDispositivoActual(opciones?: {
  /** Callback ejecutado al finalizar (éxito o error). */
  complete?: () => void;
  /** Callback ejecutado en caso de éxito. */
  success?: (respuesta: {
    /** ID único del dispositivo. */
    identificadorDispositivo: string;
  }) => void;
  /** Callback ejecutado en caso de error. */
  fail?: (respuesta: {
    mensajeError: string;
    codigoError: string | number;
    errorInterno: {
      codigoError: string | number;
      mensajeError: string;
    };
  }) => void;
}): void;

obtenerListaIdsDispositivosVinculados

outdoor.getBoundDeviceIdList

Recupera la lista de identificadores de los dispositivos que están vinculados a la cuenta del usuario.

Requiere importar OutdoorKit, disponible a partir de la versión 1.0.1.

Uso en Ray

// @ray-js/ray >=1.4.40
import { outdoor } from '@ray-js/ray';
const { getBoundDeviceIdList: obtenerListaIdsDispositivosVinculados } = outdoor;

Parámetros

Object opciones

Parámetros de retorno de object.success

Object respuesta

Parámetros de retorno de object.fail

Object respuesta

Definición de la función (ejemplo)

/**
 * Obtiene la lista de IDs de dispositivos vinculados.
 */
export function obtenerListaIdsDispositivosVinculados(opciones?: {
  /** Callback ejecutado al finalizar (éxito o error). */
  complete?: () => void;
  /** Callback ejecutado en caso de éxito. */
  success?: (respuesta: {
    /** Array con los IDs de los dispositivos vinculados. */
    listaIdentificadores: string[];
  }) => void;
  /** Callback ejecutado en caso de error. */
  fail?: (respuesta: {
    mensajeError: string;
    codigoError: string | number;
    errorInterno: {
      codigoError: string | number;
      mensajeError: string;
    };
  }) => void;
}): void;

cambiarDispositivo

outdoor.switchDevice

Cambia el dispositivo activo, invocando el selector nativo del sistema operativo.

Requiere importar OutdoorKit, disponible a partir de la versión 1.0.4.

Uso en Ray

// @ray-js/ray >=1.4.40
import { outdoor } from '@ray-js/ray';
const { switchDevice: cambiarDispositivo } = outdoor;

Parámetros

Object opciones

Definición de la función (ejemplo)

/**
 * Activa el selector nativo para cambiar el dispositivo.
 */
export function cambiarDispositivo(opciones?: {
  /** Callback ejecutado al finalizar (éxito o error). */
  complete?: () => void;
  /** Callback ejecutado en caso de éxito. El parámetro indica si se seleccionó un nuevo dispositivo. */
  success?: (nuevoSeleccionado: boolean) => void;
  /** Callback ejecutado en caso de error. */
  fail?: (respuesta: {
    mensajeError: string;
    codigoError: string | number;
    errorInterno: {
      codigoError: string | number;
      mensajeError: string;
    };
  }) => void;
}): void;