Shell.Configuration.js

 

Se aplica a: Windows Azure Pack

Obtiene o crea las opciones de configuración asociadas al usuario que ha iniciado sesión en el sitio.

Los valores de configuración se guardan en el servidor. El servidor puede quitar regularmente la configuración guardada que ya no es necesaria.

Widgets

Ninguno.

Propiedades

Ninguno.

Métodos

Nombre	Descripción	Devuelve	Parámetros
Shell.Configuration.createFullUserSettings	Crea un objeto de configuración de usuario completo. Ajusta la configuración con atributos compartidos.	Object	store (String): store (nombre de extensión). type (String): tipo de configuración: usuario o suscripción. subscriptionId (String): identificador de subcripción. settings (Array): Configuración que se va a ajustar.
Shell.Configuration.createSingleUserSetting	Crea un objeto de configuración de usuario único completo.	Object	store (String): store (nombre de extensión). type (String): tipo de configuración: usuario o suscripción. subscriptionId (String): identificador de subcripción. resourceName (String): nombre del recurso. name (String): nombre de configuración. value (String): valor de configuración.
Shell.Configuration.createUserSetting	Crea un objeto de configuración de usuario.	Object	resourceName (String): name (String): value (String):
Shell.Configuration.deleteLoadedUserSettings	Elimina la configuración de usuario que se precargó previamente.	jQuery.Deferred	args (Object): argumentos que describen la configuración que se va a eliminar.
Shell.Configuration.deleteUserSettings	Elimina la configuración de usuario.	jQuery.Deferred	args (Object): argumentos que describen la configuración que se va a eliminar.
Shell.Configuration.deleteUserSettingsByPrefix	Elimina la configuración del usuario cuyas rutas de acceso coinciden con uno de un conjunto de prefijos de ruta de acceso proporcionados.	jQuery.Deferred	args (Object): argumentos que describen la configuración que se va a eliminar.
Shell.Configuration.getLoadedUserSettings	Obtiene los valores de configuración de pares de ruta de acceso y nombre específicos de una memoria caché precargada.	jQuery.Deferred	args (Object): argumentos que describen los pares setting-path/name.
Shell.Configuration.getUserSettings	Obtiene los valores de configuración de pares de ruta de acceso o nombre específicos.	jQuery.Deferred	args (Object): argumentos que describen los pares setting-path/name. useCache (booleano): use la memoria caché en lugar de consultar directamente el servidor. readThroughCache (Boolean): capture desde el servicio de configuración si la configuración no está presente en la memoria caché.
Shell.Configuration.initialize	Inicializa la memoria caché de configuración.	jQuery.Deferred	Ninguno.
Shell.Configuration.updateLoadedUserSettings	Novedades valores de configuración de usuario que se cargaron previamente.	jQuery.Deferred	args (Object): argumentos que describen la configuración que se va a actualizar. delaySyncWithService (Boolean): retrasar el guardado en el servicio de configuración de usuario durante 5 segundos después de la actualización más reciente para reducir el chatter de red.
Shell.Configuration.updateUserSetting	Novedades una configuración de usuario único.	jQuery.Deferred	setting (Object): Configuración actualizar. Se actualiza una sola, [0]. value (String): claves que se van a eliminar.
Shell.Configuration.updateUserSettings	Novedades la configuración del usuario.	jQuery.Deferred	args (Object): argumentos que describen la configuración que se va a actualizar. updateCache (booleano): Novedades la memoria caché además de actualizar la configuración en el servicio de configuración.

Ejemplos

Obtener la configuración de usuario:

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

Cree o cambie el valor de una configuración de usuario:

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

Eliminar una configuración de usuario:

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

Consulte también

Referencia de la biblioteca de shell de extensión de paquete de Azure Windows