Obsolète. Cette classe est obsolète et ne doit pas être utilisée dans de nouveaux scripts.
Les propriétés utilisateur sont des paires clé-valeur uniques pour chaque utilisateur. Les propriétés utilisateur sont définies par utilisateur. tout script exécuté sous l'identité d'un utilisateur ne peut accéder aux propriétés utilisateur que pour cet utilisateur.
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" en l'absence de valeur de ce type. |
|
| Définit de manière groupée toutes les propriétés dessinées à partir de l'objet donné. |
|
| Définit de manière groupée toutes les propriétés dessinées à partir de l'objet donné. |
|
| Conserver la valeur spécifiée avec la clé fournie. |
Méthodes obsolètes
deleteAllProperties()
deleteAllProperties()
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.
Supprime toutes les propriétés.
UserProperties.deleteAllProperties();
Renvois
: cet objet, pour le chaînageUserProperties
Voir aussi
deleteProperty(key)
deleteProperty(key)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.
Supprime la propriété avec la clé donnée.
UserProperties.deleteProperty('special');
Paramètres
Nom | Type | Description |
---|---|---|
key | String | clé de la propriété à supprimer |
Renvois
: cet objet, pour le chaînageUserProperties
Voir aussi
getKeys()
getKeys()
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.
Obtenez toutes les clés disponibles.
Renvois
String[]
getProperties()
getProperties()
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.
Obtenez toutes les propriétés disponibles en même temps.
Cela donne une copie et non une vue en direct. Par conséquent, modifier les propriétés de l'objet renvoyé n'aura pas les mettre à jour dans Storage, et inversement.
UserProperties.setProperties({ "cow" : "moo", "sheep" : "baa", "chicken" : "cluck" }); // Logs "A cow goes: moo" Logger.log("A cow goes: %s", UserProperties.getProperty("cow")); // This makes a copy. Any changes that happen here will not // be written back to properties. var animalSounds = UserProperties.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
getProperty(key)
getProperty(key)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.
Renvoie la valeur associée à la clé fournie, ou la valeur "null" en l'absence de valeur de ce type.
var specialValue = UserProperties.getProperty('special');
Paramètres
Nom | Type | Description |
---|---|---|
key | String | pour la valeur à récupérer |
Renvois
String
: valeur associée à la clé
Voir aussi
setProperties(properties)
setProperties(properties)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.
Définit de manière groupée toutes les propriétés dessinées à partir de l'objet donné.
UserProperties.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înageUserProperties
Voir aussi
setProperties(properties, deleteAllOthers)
setProperties(properties, deleteAllOthers)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.
Définit de manière groupée toutes les propriétés dessinées à partir de l'objet donné.
// This deletes all other properties UserProperties.setProperties({special: 'sauce', 'meaning': 42}, true);
Paramètres
Nom | Type | Description |
---|---|---|
properties | Object | un objet contenant les propriétés à définir. |
deleteAllOthers | Boolean | si toutes les propriétés existantes doivent être supprimées. |
Renvois
: cet objet, pour le chaînageUserProperties
Voir aussi
setProperty(key, value)
setProperty(key, value)
Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.
Conserver la valeur spécifiée avec la clé fournie. Toute valeur existante associée à ce sera écrasée.
UserProperties.setProperty('special', 'sauce');
Paramètres
Nom | Type | Description |
---|---|---|
key | String | clé de propriété |
value | String | à associer à la clé |
Renvois
: cet objet, pour le chaînageUserProperties