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 |
---|---|---|
|
| Exclui todas as propriedades. |
|
| Exclui a propriedade com a chave fornecida. |
| String[] | Acesse todas as chaves disponíveis. |
| Object | Consiga todas as propriedades disponíveis de uma só vez. |
| String | Retorna o valor associado à chave fornecida ou nulo se não houver esse valor. |
|
| Define em massa todas as propriedades extraídas do objeto especificado. |
|
| Define em massa todas as propriedades extraídas do objeto especificado. |
|
| Mantém o valor especificado com a chave fornecida. |
Métodos obsoletos
deleteAllProperties()
deleteAllProperties()
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Exclui todas as propriedades.
UserProperties.deleteAllProperties();
Retorno
: este objeto, para encadeamento.UserProperties
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
: este objeto, para encadeamento.UserProperties
Veja também
getKeys()
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()
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)
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
setProperties(properties)
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
: este objeto, para encadeamento.UserProperties
Veja também
setProperties(properties, deleteAllOthers)
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
: este objeto, para encadeamento.UserProperties
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
: este objeto, para encadeamento.UserProperties