Class UserProperties

Propiedades del usuario

Obsoleto. Esta clase está obsoleta y no se debe usar en secuencias de comandos nuevas.

Las propiedades del usuario son pares clave-valor únicos para un usuario. Las propiedades del usuario se definen por usuario. Cualquier secuencia de comandos que se ejecute con la identidad de un usuario solo puede acceder a las propiedades del usuario de ese usuario.

MétodoTipo de datos que se muestraDescripción breve
deleteAllProperties()UserPropertiesBorra todas las propiedades.
deleteProperty(key)UserPropertiesBorra la propiedad con la clave determinada.
getKeys()String[]Obtén todas las claves disponibles.
getProperties()ObjectObtén todas las propiedades disponibles de una sola vez.
getProperty(key)StringMuestra el valor asociado con la clave proporcionada o nulo si no hay un valor de ese tipo.
setProperties(properties)UserPropertiesEstablece de forma masiva todas las propiedades extraídas del objeto determinado.
setProperties(properties, deleteAllOthers)UserPropertiesEstablece de forma masiva todas las propiedades extraídas del objeto determinado.
setProperty(key, value)UserPropertiesConserva el valor especificado en con la clave proporcionada.

Métodos obsoletos

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Borra todas las propiedades.

UserProperties.deleteAllProperties();

Volver

UserProperties: Este objeto, para encadenar

Consulta también


Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Borra la propiedad con la clave determinada.

UserProperties.deleteProperty('special');

Parámetros

NombreTipoDescripción
keyStringclave de la propiedad que se borrará

Volver

UserProperties: Este objeto, para encadenar

Consulta también


Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén todas las claves disponibles.

Volver

String[]


Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén todas las propiedades disponibles de una sola vez.

Esto proporciona una copia, no una vista en vivo, por lo que cambiar las propiedades del objeto que se muestra no las actualizará en el almacenamiento ni viceversa.

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]);
}

Volver

Object: Es una copia de las propiedades que contienen pares clave-valor.


Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Muestra el valor asociado con la clave proporcionada o nulo si no hay un valor de ese tipo.

const specialValue = UserProperties.getProperty('special');

Parámetros

NombreTipoDescripción
keyStringclave del valor que se recuperará

Volver

String: Es el valor asociado con la clave.

Consulta también


Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Establece de forma masiva todas las propiedades extraídas del objeto determinado.

UserProperties.setProperties({special: 'sauce', 'meaning': 42});

Parámetros

NombreTipoDescripción
propertiesObjectUn objeto que contiene las propiedades que se deben establecer.

Volver

UserProperties: Este objeto, para encadenar

Consulta también


Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Establece de forma masiva todas las propiedades extraídas del objeto determinado.

// This deletes all other properties
UserProperties.setProperties({special: 'sauce', 'meaning': 42}, true);

Parámetros

NombreTipoDescripción
propertiesObjectUn objeto que contiene las propiedades que se deben establecer.
deleteAllOthersBooleansi quieres borrar todas las propiedades existentes.

Volver

UserProperties: Este objeto, para encadenar

Consulta también


Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Conserva el valor especificado en con la clave proporcionada. Se sobrescribirá cualquier valor existente asociado con esta clave.

UserProperties.setProperty('special', 'sauce');

Parámetros

NombreTipoDescripción
keyStringclave para la propiedad
valueStringvalor para asociar con la clave

Volver

UserProperties: Este objeto, para encadenar

Consulta también