Esta página foi traduzida pela API Cloud Translation.

Class UserProperties

Obsoleto. Esta classe foi descontinuada 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. O escopo das propriedades do usuário é definido por usuário. Qualquer script executado com a identidade de um usuário pode acessar essas propriedades apenas para esse 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[]`	Acesse todas as chaves disponíveis.
`getProperties()`	`Object`	Consiga todas as propriedades disponíveis de uma só vez.
`getProperty(key)`	`String`	Retorna o valor associado à chave fornecida ou nulo se não houver esse valor.
`setProperties(properties)`	`UserProperties`	Define em massa todas as propriedades extraídas do objeto especificado.
`setProperties(properties, deleteAllOthers)`	`UserProperties`	Define em massa todas as propriedades extraídas do objeto especificado.
`setProperty(key, value)`	`UserProperties`	Mantém o valor especificado com a chave fornecida.

Métodos obsoletos

`deleteAllProperties()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Exclui todas as propriedades.

UserProperties.deleteAllProperties();

Retorno

UserProperties: este objeto, para encadeamento.

Veja também

deleteProperty(key)

`deleteProperty(key)`

Obsoleto. Esta função foi descontinuada 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

Retorno

UserProperties: este objeto, para encadeamento.

Veja também

deleteAllProperties()

`getKeys()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Acesse todas as chaves disponíveis.

Retorno

String[]

`getProperties()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

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

Isso fornece uma cópia, não uma visualização ao vivo. Portanto, a alteração das propriedades no objeto retornado não as atualizará 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]);
}

Retorno

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

`getProperty(key)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

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

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

Parâmetros

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

Retorno

String: o valor associado à chave

Veja também

setProperty(key, value)

`setProperties(properties)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

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

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

Parâmetros

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

Retorno

UserProperties: este objeto, para encadeamento.

Veja também

setProperty(key, value)

`setProperties(properties, deleteAllOthers)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

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

// 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`	se todas as propriedades atuais precisam ser excluídas.

Retorno

UserProperties: este objeto, para encadeamento.

Veja também

setProperty(key, value)

`setProperty(key, value)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Mantém o valor especificado com a chave fornecida. Qualquer valor atual associado a essa chave será substituído.

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

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	chave da propriedade
`value`	`String`	que será associado à chave

Retorno

UserProperties: este objeto, para encadeamento.

Veja também

getProperty(key)