Shell.Configuration.js

Artikel
08/24/2015

Van toepassing op: Windows Azure Pack

Hiermee haalt u de configuratie-instellingen op die zijn gekoppeld aan de gebruiker die is aangemeld op de site.

Configuratie-instellingen worden opgeslagen op de server. De server kan regelmatig opgeslagen instellingen verwijderen die niet meer nodig zijn.

Widgets

Geen.

Eigenschappen

Geen.

Methoden

Naam	Beschrijving	Retouren	Parameters
Shell.Configuration.createFullUserSettings	Hiermee maakt u een volledig object voor gebruikersinstellingen. Verpakte instellingen met gedeelde kenmerken.	Object	store (tekenreeks): store (extensienaam). type (tekenreeks): instellingstype: gebruiker of abonnement. subscriptionId (tekenreeks): subscriptie-id. instellingen (matrix): Instellingen te verpakken.
Shell.Configuration.createSingleUserSetting	Hiermee maakt u een volledig object met één gebruikersinstellingen.	Object	store (tekenreeks): store (extensienaam). type (tekenreeks): instellingstype: gebruiker of abonnement. subscriptionId (tekenreeks): subscriptie-id. resourceName (tekenreeks): resourcenaam. naam (tekenreeks): naam van instelling. waarde (tekenreeks): instellingswaarde.
Shell.Configuration.createUserSetting	Hiermee maakt u een gebruikersinstellingsobject.	Object	resourceName (tekenreeks): naam (tekenreeks): waarde (tekenreeks):
Shell.Configuration.deleteLoadedUserSettings	Hiermee verwijdert u gebruikersinstellingen die eerder vooraf zijn geladen.	jQuery.Deferred	args (Object): Argumenten die de instellingen beschrijven die moeten worden verwijderd.
Shell.Configuration.deleteUserSettings	Hiermee verwijdert u gebruikersinstellingen.	jQuery.Deferred	args (Object): Argumenten die de instellingen beschrijven die moeten worden verwijderd.
Shell.Configuration.deleteUserSettingsByPrefix	Hiermee verwijdert u gebruikersinstellingen waarvan de paden overeenkomen met een van een set opgegeven padvoorvoegsels.	jQuery.Deferred	args (Object): Argumenten die de instellingen beschrijven die moeten worden verwijderd.
Shell.Configuration.getLoadedUserSettings	Hiermee haalt u waarden op voor specifieke pad-/naamparen uit een vooraf geladen cache.	jQuery.Deferred	args (Object): Argumenten die het instellingspad/naamparen beschrijven.
Shell.Configuration.getUserSettings	Hiermee worden waarden voor specifieke pad-/naamparen opgehaald.	jQuery.Deferred	args (Object): Argumenten die het instellingspad/naamparen beschrijven. useCache (Booleaanse waarde): gebruik de cache in plaats van rechtstreeks een query uit te voeren op de server. readThroughCache (Booleaanse waarde): Ophalen van de instellingenservice als de instellingen niet aanwezig zijn in de cache.
Shell.Configuration.initialize	Initialiseert de configuratiecache.	jQuery.Deferred	Geen.
Shell.Configuration.updateLoadedUserSettings	Updates waarden voor gebruikersinstellingen die eerder vooraf zijn geladen.	jQuery.Deferred	args (Object): Argumenten die de instellingen beschrijven die moeten worden bijgewerkt. delaySyncWithService (Booleaanse waarde): Vertraging bij opslaan naar service voor gebruikersinstellingen gedurende 5 seconden na de meest recente update om netwerkchatter te verminderen.
Shell.Configuration.updateUserSetting	Updates één gebruikersinstelling.	jQuery.Deferred	instelling (Object): Instellingen om bij te werken. Eén, [0] wordt bijgewerkt. waarde (tekenreeks): sleutels die moeten worden verwijderd.
Shell.Configuration.updateUserSettings	Updates de gebruikersinstellingen.	jQuery.Deferred	args (Object): Argumenten die de instellingen beschrijven die moeten worden bijgewerkt. updateCache (Booleaanse waarde): Updates de cache naast het bijwerken van instellingen in de instellingenservice.

Voorbeelden

Gebruikersinstellingen ophalen:

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

De waarde van een gebruikersinstelling maken of wijzigen:

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

Een gebruikersinstelling verwijderen:

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

Zie ook

Naslaginformatie over Windows Azure Pack Extension Shell-bibliotheek

Delen via