Device address validation result

El objeto device address validation result representa el resultado de la validación de una dirección de dispositivo, típicamente empleado en los scripts de configuración de un modelo de dispositivo.

La función validateDeviceAddress recibe como parámetro un objeto de este tipo, que permite validar la dirección dada como parámetro, e indicar el resultado de la validación.

Propiedades

### ok (boolean) La propiedad ok indica si la validación fue correcta. El valor true indica que la dirección indicada es correcta, mientras que el valor false indica que la dirección no puede ser aceptada. En caso de devolver el valor true, es posible además asignar un valor a la propiedad updatedAddress, opcionalmente, si se desea modificar la dirección indicada. En ese caso, la plataforma utilizará el valor de la propiedad updatedAddress para el dispositivo.

Ejemplos

Este ejemplo permite validar la dirección de un dispositivo, verificando que tenga 10 caracteres. En caso de que la validación sea correcta, se pasa además la dirección a minúsculas. En caso de que la validación no sea correcta, se indica un mensaje de error.

function validateDeviceAddress(address, result)
{
	result.ok = address.length == 10;
	if (result.ok)
	{
		result.updatedAddress = address.toLowerCase();
	}
	else 
	{
		result.errorMessage = {
			en: "The address must be exactly 10 characters long", 
			es: "La dirección debe tener exactamente 10 caracteres"
		};
	}
}

### updatedAddress (string) La propiedad updatedAddress permite modificar la dirección que se está validando, de manera que si la validación es correcta, pueda utilizarse una dirección diferente. Por defecto, el valor de esta propiedad es igual al de la dirección pasada como parámetro a la función validateDeviceAddress. Normalmente, la dirección puede cambiarse para darle un formato consistente.

Ejemplos

Puede verse un ejemplo completo en la documentación de la propiedad ok, más arriba.

### errorMessage (string o multi-language literal) La propiedad errorMessage permite indicar un mensaje de error, en caso de que la propiedad ok tenga valor false. Para indicar un mensaje de error, puede indicarse un valor de tipo string o multi language literal. Si se utiliza un objeto multi language literal, es posible indicar mensajes en diferentes idiomas.

Ejemplos

Puede verse un ejemplo completo en la documentación de la propiedad ok, más arriba.