Shell.Configuration.js

Artigo
08/24/2015

Aplica-se a: Windows Azure Pack

Obtém ou cria as definições de configuração associadas ao utilizador que está iniciado no site.

As definições de configuração são guardadas no servidor. O servidor pode remover regularmente as definições guardadas que já não são necessárias.

Widgets

Nenhum.

Propriedades

Nenhum.

Métodos

Nome	Descrição	Devoluções	Parâmetros
Shell.Configuration.createFullUserSettings	Cria um objeto de definições completa do utilizador. Embrulha as definições com atributos partilhados.	Objeto	loja (String): loja (nome de extensão). tipo (String): tipo de definição: utilizador ou subscrição. subscriçid (String): id de subcrição. definições (Matriz): Definições para embrulhar.
Shell.Configuration.createSingleUserSetting	Cria um objeto de configuração de um único utilizador completo.	Objeto	loja (String): loja (nome de extensão). tipo (String): tipo de definição: utilizador ou subscrição. subscriçid (String): id de subcrição. nome de recurso (String): nome de recurso. nome (String): nome de definição. valor (String): valor de definição.
Shell.Configuration.createUserSetting	Cria um objeto de definição de utilizador.	Objeto	nome de recurso (String): nome (String): valor (Cadeia):
Shell.Configuration.deleteSerSettingsloadedUser	Elimina as definições do utilizador que foram pré-carregadas anteriormente.	jQuery.Diferido	args (Objeto): Argumentos que descrevem as definições a eliminar.
Shell.Configuration.deleteUserSettings	Elimina as definições do utilizador.	jQuery.Diferido	args (Objeto): Argumentos que descrevem as definições a eliminar.
Shell.Configuration.deleteUserSettingsByPrefix	Elimina as definições do utilizador cujos caminhos correspondem a um de um conjunto de prefixos de caminhos fornecidos.	jQuery.Diferido	args (Objeto): Argumentos que descrevem as definições a eliminar.
Shell.Configuration.getLoadedUserSettings	Obtém valores de definição para pares de caminhos/nomes específicos a partir de uma cache pré-carregada.	jQuery.Diferido	args (Objeto): Argumentos que descrevem os pares de cenários/nomes.
Shell.Configuration.getUserSettings	Obtém valores de definição para pares de caminhos/nomes específicos.	jQuery.Diferido	args (Objeto): Argumentos que descrevem os pares de cenários/nomes. useCache (Boolean): Utilize a cache em vez de consultar diretamente o servidor. readThroughCache (Boolean): Retire do serviço de definições se as definições não estiverem presentes na cache.
Shell.Configuration.initialize	Inicializa a cache de configuração.	jQuery.Diferido	Nenhum.
Shell.Configuration.updateLoadedUserSettings	Atualizações valores de definição do utilizador que foram previamente pré-carregados.	jQuery.Diferido	args (Objeto): Argumentos que descrevem as definições a atualizar. delaySyncWithService (Boolean): Atraso na poupança para o serviço de definições do utilizador durante 5 segundos após a atualização mais recente para reduzir as conversas de rede.
Shell.Configuration.updateUserSetting	Atualizações uma única definição de utilizador.	jQuery.Diferido	definição (Objeto): Definições a atualizar. Um único, [0] é atualizado. valor (String): Chaves para eliminar.
Shell.Configuration.updateUserSettings	Atualizações as definições do utilizador.	jQuery.Diferido	args (Objeto): Argumentos que descrevem as definições a atualizar. actualizarCache (Boolean): Atualizações a cache para além de atualizar as definições no serviço de definições.

Exemplos

Obtenha as definições do utilizador:

Shell.Configuration.getUserSettings("thesettingINeedToAccess").then(
    function(result) {
        if (result) {
            result.Value; // do something useful with the value
        } else {
            // setting does not exist
        }
    },
    function(error) {
        // Failed to contact server
    }
);

Criar ou alterar o valor de uma definição de utilizador:

Shell.Configuration.updateUserSettings({ Name: "the-setting-to-update", Value: "theNewValue" }).then(
    function(result) {
        // result is the setting which was changed
    },
    function(error) {
        // Failed to contact server
    }
);

Excluir uma definição do utilizador:

Shell.Configuration.deleteUserSettings("setting1-to-delete").then(
    function(result) {
        // completed
    },
    function(error) {
        // Failed to contact server
    }
);

Consulte também

Windows referência da biblioteca da extensão do pacote Azure

Partilhar via