requireUi

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

Un objet de service Apps Script n'a pas de constructeur contre lequel un script pourrait tester, alors le garde lit le tag que l'objet déclare pour lui-même : value.toString() === "Ui". Un objet ordinaire qui déclare le même tag passe aussi, ce qui en pratique désigne un double de test.

isX et nonX répondent à une question sans jamais interrompre le flot ; requireX et requireNonX rendent la valeur ou lèvent. Le schéma est expliqué dans Conventions de validation.

Paramètres

Paramètre	Type	Description
`value`	`unknown`	La valeur à valider.
`message` (facultatif) `= "Expected a Ui object."`	`string`	Le message de l'exception. À défaut, un message par défaut est utilisé.

Valeur de retour

GoogleAppsScript.Base.Ui — la même valeur, typée comme un objet Ui.

Exceptions

Exception	Condition
`IllegalArgumentException`	la valeur n'est pas un objet Ui.

Exemples

Ce qui passe et ce qui ne passe pas

const ui = SpreadsheetApp.getUi();

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

Voir aussi

Code source

src/appsscript/ui/requireUi.ts

23 September 2026

Cette documentation a été générée par une IA (Claude) à partir du code source de la bibliothèque.