Shell.Configuration.js

 

Gäller för: Windows Azure Pack

Hämtar eller skapar de konfigurationsinställningar som är associerade med den användare som är inloggad på webbplatsen.

Konfigurationsinställningarna sparas på servern. Servern kan regelbundet ta bort sparade inställningar som inte längre behövs.

Widgets

Inga.

Egenskaper

Inga.

Metoder

Name	Beskrivning	Returer	Parametrar
Shell.Configuration.createFullUserSettings	Skapar ett fullständigt användarinställningsobjekt. Omsluter inställningar med delade attribut.	Objekt	store (String): store (tilläggsnamn). type (String): inställningstyp: användare eller prenumeration. subscriptionId (sträng): prenumerations-ID. inställningar (matris): Inställningar att omsluta.
Shell.Configuration.createSingleUserSetting	Skapar ett fullständigt objekt för enskilda användarinställningar.	Objekt	store (String): store (tilläggsnamn). type (String): inställningstyp: användare eller prenumeration. subscriptionId (sträng): prenumerations-ID. resourceName (sträng): resursnamn. name (String): inställningsnamn. value (String): inställningsvärde.
Shell.Configuration.createUserSetting	Skapar ett användarinställningsobjekt.	Objekt	resourceName (sträng): name (String): värde (sträng):
Shell.Configuration.deleteLoadedUserSettings	Tar bort användarinställningar som tidigare har förinstallerats.	jQuery.Deferred	args (object): Argument som beskriver de inställningar som ska tas bort.
Shell.Configuration.deleteUserSettings	Tar bort användarinställningar.	jQuery.Deferred	args (object): Argument som beskriver de inställningar som ska tas bort.
Shell.Configuration.deleteUserSettingsByPrefix	Tar bort användarinställningar vars sökvägar matchar ett av de angivna sökvägsprefixen.	jQuery.Deferred	args (object): Argument som beskriver de inställningar som ska tas bort.
Shell.Configuration.getLoadedUserSettings	Hämtar inställningsvärden för specifika sökvägs-/namnpar från en förinstallerad cache.	jQuery.Deferred	args (object): Argument som beskriver paren setting-path/name.
Shell.Configuration.getUserSettings	Hämtar inställningsvärden för specifika sökväg/namnpar.	jQuery.Deferred	args (object): Argument som beskriver paren setting-path/name. useCache (booleskt): Använd cachen i stället för att fråga servern direkt. readThroughCache (booleskt): Hämta från inställningstjänsten om inställningarna inte finns i cacheminnet.
Shell.Configuration.initialize	Initierar konfigurationscacheminnet.	jQuery.Deferred	Inga.
Shell.Configuration.updateLoadedUserSettings	Uppdateringar användarinställningsvärden som tidigare har förinlästs.	jQuery.Deferred	args (object): Argument som beskriver de inställningar som ska uppdateras. delaySyncWithService (boolesk): Fördröj besparing till tjänsten för användarinställningar i 5 sekunder efter den senaste uppdateringen för att minska nätverkschatten.
Shell.Configuration.updateUserSetting	Uppdateringar en inställning för en enskild användare.	jQuery.Deferred	inställning (objekt): Inställningar att uppdatera. En enda, [0] uppdateras. value (String): Nycklar som ska tas bort.
Shell.Configuration.updateUserSettings	Uppdateringar användarinställningarna.	jQuery.Deferred	args (object): Argument som beskriver de inställningar som ska uppdateras. updateCache (booleskt): Uppdateringar cachen utöver uppdateringsinställningarna i inställningstjänsten.

Exempel

Hämta användarinställningar:

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

Skapa eller ändra värdet för en användarinställning:

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

Ta bort en användarinställning:

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

Se även

biblioteksreferens för Windows Azure Pack-tilläggsgränssnitt