Class UserProperties

UserProperties

Obsoleto. Essa classe está obsoleta e não pode ser usada em novos scripts.

As propriedades do usuário são pares de chave-valor exclusivos de um usuário. Elas têm escopo por usuário. Qualquer script executado na identidade de um usuário só pode acessar as propriedades desse usuário.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
deleteAllProperties()	UserProperties	Exclui todas as propriedades.
deleteProperty(key)	UserProperties	Exclui a propriedade com a chave fornecida.
getKeys()	String[]	Recebe todas as chaves disponíveis.
getProperties()	Object	Recebe todas as propriedades disponíveis de uma só vez.
getProperty(key)	String|null	Retorna o valor associado à chave fornecida ou null se não houver esse valor.
setProperties(properties)	UserProperties	Define em massa todas as propriedades extraídas do objeto fornecido.
setProperties(properties, deleteAllOthers)	UserProperties	Define em massa todas as propriedades extraídas do objeto fornecido.
setProperty(key, value)	UserProperties	Persiste o valor especificado na chave fornecida.

Métodos obsoletos

deleteAllProperties()

Obsoleto. Essa função está obsoleta e não pode ser usada em novos scripts.

Exclui todas as propriedades.

UserProperties.deleteAllProperties();

Retornar

UserProperties — esse objeto, para encadeamento

Consulte também

• deleteProperty(key)

---

deleteProperty(key)

Obsoleto. Essa função está obsoleta e não pode ser usada em novos scripts.

Exclui a propriedade com a chave fornecida.

UserProperties.deleteProperty('special');

Parâmetros

Nome	Tipo	Descrição
key	String	chave da propriedade a ser excluída

Retornar

UserProperties — esse objeto, para encadeamento

Consulte também

• deleteAllProperties()

---

getKeys()

Obsoleto. Essa função está obsoleta e não pode ser usada em novos scripts.

Recebe todas as chaves disponíveis.

Retornar

String[]

---

getProperties()

Obsoleto. Essa função está obsoleta e não pode ser usada em novos scripts.

Recebe todas as propriedades disponíveis de uma só vez.

Isso fornece uma cópia, não uma visualização dinâmica. Portanto, a mudança das propriedades no objeto retornado não as atualiza no armazenamento e vice-versa.

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

Retornar

Object — uma cópia das propriedades que contêm pares de chave-valor

---

getProperty(key)

Obsoleto. Essa função está obsoleta e não pode ser usada em novos scripts.

Retorna o valor associado à chave fornecida ou null se não houver esse valor.

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

Parâmetros

Nome	Tipo	Descrição
key	String	chave do valor a ser recuperado

Retornar

String|null — o valor associado à chave

Consulte também

• setProperty(key, value)

---

setProperties(properties)

Obsoleto. Essa função está obsoleta e não pode ser usada em novos scripts.

Define em massa todas as propriedades extraídas do objeto fornecido.

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

Parâmetros

Nome	Tipo	Descrição
properties	Object	um objeto que contém as propriedades a serem definidas.

Retornar

UserProperties — esse objeto, para encadeamento

Consulte também

• setProperty(key, value)

---

setProperties(properties, deleteAllOthers)

Obsoleto. Essa função está obsoleta e não pode ser usada em novos scripts.

Define em massa todas as propriedades extraídas do objeto fornecido.

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

Parâmetros

Nome	Tipo	Descrição
properties	Object	um objeto que contém as propriedades a serem definidas.
deleteAllOthers	Boolean	indica se todas as propriedades atuais serão excluídas.

Retornar

UserProperties — esse objeto, para encadeamento

Consulte também

• setProperty(key, value)

---

setProperty(key, value)

Obsoleto. Essa função está obsoleta e não pode ser usada em novos scripts.

Persiste o valor especificado na chave fornecida. Qualquer valor associado a essa chave será substituído.

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

Parâmetros

Nome	Tipo	Descrição
key	String	chave da propriedade
value	String	valor a ser associado à chave

Retornar

UserProperties — esse objeto, para encadeamento

Consulte também

• getProperty(key)