requireUi

function requireUi(
  value: unknown,
  message: string = "Expected a Ui object."
): GoogleAppsScript.Base.Ui;

Ein Apps-Script-Dienstobjekt hat keinen Konstruktor, gegen den ein Skript prüfen könnte, also liest die Prüfung den Tag, den das Objekt über sich selbst meldet: value.toString() === "Ui". Ein einfaches Objekt mit demselben Tag besteht ebenfalls — in der Praxis ist das ein Test-Double.

isX und nonX beantworten eine Frage und unterbrechen den Ablauf nie; requireX und requireNonX geben den Wert zurück oder werfen. Das Schema erklärt Konventionen der Prüfungen.

Parameter

Parameter	Typ	Beschreibung
`value`	`unknown`	Der zu validierende Wert.
`message` (optional) `= "Expected a Ui object."`	`string`	Die Meldung der Ausnahme. Ohne Angabe wird eine Standardmeldung verwendet.

Rückgabewert

GoogleAppsScript.Base.Ui — denselben Wert, typisiert als ein Ui-Objekt.

Ausnahmen

Ausnahme	Bedingung
`IllegalArgumentException`	der Wert ist nicht ein Ui-Objekt.

Beispiele

Was besteht und was nicht

const ui = SpreadsheetApp.getUi();

requireUi(ui); // => ui
requireUi({}); // throws IllegalArgumentException
requireUi(null); // throws IllegalArgumentException

Siehe auch

Quellcode

src/appsscript/ui/requireUi.ts

23 September 2026

Diese Dokumentation wurde mit KI (Claude) aus dem Quellcode der Bibliothek erzeugt.