Ergebnis der Geräteadress-Validierung

Das Ergebnisobjekt der Geräteadress-Validierung repräsentiert das Ergebnis einer Geräteadress-Validierung, das typischerweise in Konfigurationsskripten für Gerätemodelle verwendet wird.

Die validateDeviceAddress-Funktion erhält ein Objekt dieses Typs als Parameter, das die Validierung der angegebenen Adresse und die Angabe des Validierungsergebnisses ermöglicht.

Eigenschaften

ok (boolean) Die ok-Eigenschaft gibt an, ob die Validierung erfolgreich war. Der Wert true zeigt an, dass die angegebene Adresse korrekt ist, während der Wert false anzeigt, dass die Adresse nicht akzeptiert werden kann. Bei Rückgabe des Werts true ist es auch möglich, optional einen Wert der updatedAddress-Eigenschaft zuzuweisen, falls die angegebene Adresse geändert werden muss. In diesem Fall verwendet die Plattform den Wert der updatedAddress-Eigenschaft für das Gerät.

Beispiele

Dieses Beispiel validiert eine Geräteadresse und überprüft, ob sie 10 Zeichen hat. Wenn die Validierung erfolgreich ist, wird die Adresse auch in Kleinbuchstaben umgewandelt. Wenn die Validierung nicht erfolgreich ist, wird eine Fehlermeldung angegeben.

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) Die updatedAddress-Eigenschaft ermöglicht die Änderung der zu validierenden Adresse, sodass bei erfolgreicher Validierung eine andere Adresse verwendet werden kann. Standardmäßig entspricht der Wert dieser Eigenschaft der Adresse, die als Parameter an die validateDeviceAddress-Funktion übergeben wurde. Typischerweise kann die Adresse geändert werden, um ihr ein einheitliches Format zu geben.

Beispiele

Ein vollständiges Beispiel finden Sie in der Dokumentation der ok-Eigenschaft oben.

errorMessage (string oder mehrsprachiges Literal) Die errorMessage-Eigenschaft ermöglicht die Angabe einer Fehlermeldung, wenn die ok-Eigenschaft den Wert false hat. Um eine Fehlermeldung anzugeben, kann ein String- oder mehrsprachiger Literal-Wert angegeben werden. Wenn ein mehrsprachiges Literal-Objekt verwendet wird, ist es möglich, Meldungen in verschiedenen Sprachen anzugeben.

Beispiele

Ein vollständiges Beispiel finden Sie in der Dokumentation der ok-Eigenschaft oben.