Obsolète. Cette classe est obsolète et ne doit pas être utilisée dans les nouveaux scripts.
Les propriétés de script sont des paires clé-valeur stockées par un script dans un store persistant. Les propriétés de script sont définies par script, quel que soit l'utilisateur qui l'exécute.
Méthodes obsolètes
Méthode | Type renvoyé | Brève description |
---|---|---|
|
| Supprime toutes les propriétés. |
|
| Supprime la propriété avec la clé donnée. |
| String[] | Obtenez toutes les clés disponibles. |
| Object | Obtenez toutes les propriétés disponibles en même temps. |
| String | Renvoie la valeur associée à la clé fournie, ou la valeur "null" si aucune valeur n'est associée. |
|
| Définit de manière groupée toutes les propriétés extraites de l'objet donné. |
|
| Définit de manière groupée toutes les propriétés extraites de l'objet donné. |
|
| Persistance de la valeur spécifiée dans la clé fournie. |
Méthodes obsolètes
delete All Properties()
delete All Properties()
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.
Supprime toutes les propriétés.
ScriptProperties .deleteAllProperties();
Renvois
: cet objet, pour le chaînageScript
Voir aussi
delete Property(key)
delete Property(key)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.
Supprime la propriété avec la clé donnée.
ScriptProperties .deleteProperty('special');
Paramètres
Nom | Type | Description |
---|---|---|
key | String | clé de la propriété à supprimer |
Renvois
: cet objet, pour le chaînageScript
Voir aussi
get Keys()
get Keys()
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.
Obtenez toutes les clés disponibles.
Renvois
String[]
get Properties()
get Properties()
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.
Obtenez toutes les propriétés disponibles en même temps.
Vous obtenez ainsi une copie, et non une vue en direct. Par conséquent, modifier les propriétés de l'objet renvoyé ne les mettra pas à jour dans l'espace de stockage, et inversement.
ScriptProperties .setProperties({ "cow" : "moo", "sheep" : "baa", "chicken" : "cluck" }); // Logs "A cow goes: moo" Logger.log("A cow goes: %s", ScriptProperties.getProperty("cow")); // This makes a copy. Any changes that happen here will not // be written back to properties. var animalSounds = ScriptProperties.getProperties(); // Logs: // A chicken goes cluck! // A cow goes moo! // A sheep goes baa! for(var kind in animalSounds) { Logger.log("A %s goes %s!", kind, animalSounds[kind]); }
Renvois
Object
: copie des propriétés contenant des paires clé-valeur
get Property(key)
get Property(key)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.
Renvoie la valeur associée à la clé fournie, ou la valeur "null" si aucune valeur n'est associée.
const specialValue = ScriptProperties.getProperty('special');
Paramètres
Nom | Type | Description |
---|---|---|
key | String | clé de la valeur à récupérer |
Renvois
String
: valeur associée à la clé
Voir aussi
set Properties(properties)
set Properties(properties)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.
Définit de manière groupée toutes les propriétés extraites de l'objet donné.
ScriptProperties .setProperties({special: 'sauce', 'meaning': 42});
Paramètres
Nom | Type | Description |
---|---|---|
properties | Object | un objet contenant les propriétés à définir. |
Renvois
: cet objet, pour le chaînageScript
Voir aussi
set Properties(properties, deleteAllOthers)
set Properties(properties, deleteAllOthers)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.
Définit de manière groupée toutes les propriétés extraites de l'objet donné.
// This deletes all other properties ScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);
Paramètres
Nom | Type | Description |
---|---|---|
properties | Object | un objet contenant les propriétés à définir. |
delete | Boolean | si vous souhaitez supprimer toutes les propriétés existantes. |
Renvois
: cet objet, pour le chaînageScript
Voir aussi
set Property(key, value)
set Property(key, value)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.
Persistance de la valeur spécifiée dans la clé fournie. Toute valeur existante associée à cette clé sera écrasée.
ScriptProperties .setProperty('special', 'sauce');
Paramètres
Nom | Type | Description |
---|---|---|
key | String | clé de la propriété |
value | String | valeur à associer à la clé |
Renvois
: cet objet, pour le chaînageScript