Shell.Configuration.js

 

Dotyczy: Windows Azure Pack

Pobiera lub tworzy ustawienia konfiguracji skojarzone z użytkownikiem zalogowanym w lokacji.

Ustawienia konfiguracji są zapisywane na serwerze. Serwer może regularnie usuwać zapisane ustawienia, które nie są już potrzebne.

Widżety

Brak.

Właściwości

Brak.

Metody

Nazwa	Opis	Zwraca	Parametry
Shell.Configuration.createFullUserSettings	Tworzy obiekt pełnych ustawień użytkownika. Opakowuje ustawienia za pomocą atrybutów udostępnionych.	Obiekt	store (String): store (nazwa rozszerzenia). typ (ciąg): typ ustawienia: użytkownik lub subskrypcja. subscriptionId (Ciąg): identyfikator subcription. settings (Array): Ustawienia do zawijania.
Shell.Configuration.createSingleUserSetting	Tworzy pełny obiekt ustawień pojedynczego użytkownika.	Obiekt	store (String): store (nazwa rozszerzenia). typ (ciąg): typ ustawienia: użytkownik lub subskrypcja. subscriptionId (Ciąg): identyfikator subcription. resourceName (ciąg): nazwa zasobu. name (Ciąg): nazwa ustawienia. wartość (ciąg): wartość ustawienia.
Shell.Configuration.createUserSetting	Tworzy obiekt ustawienia użytkownika.	Obiekt	resourceName (ciąg): name (Ciąg): wartość (ciąg):
Shell.Configuration.deleteLoadedUserSettings	Usuwa ustawienia użytkownika, które zostały wcześniej załadowane wstępnie.	jQuery.Odroczone	args (obiekt): argumenty opisujące ustawienia do usunięcia.
Shell.Configuration.deleteUserSettings	Usuwa ustawienia użytkownika.	jQuery.Odroczone	args (obiekt): argumenty opisujące ustawienia do usunięcia.
Shell.Configuration.deleteUserSettingsByPrefix	Usuwa ustawienia użytkownika, których ścieżki pasują do jednego z zestawów podanych prefiksów ścieżek.	jQuery.Odroczone	args (obiekt): argumenty opisujące ustawienia do usunięcia.
Shell.Configuration.getLoadedUserSettings	Pobiera wartości ustawień dla określonych par ścieżki/nazwy ze wstępnie załadowanej pamięci podręcznej.	jQuery.Odroczone	args (obiekt): argumenty opisujące pary setting-path/name.
Shell.Configuration.getUserSettings	Pobiera wartości ustawień dla określonych par ścieżki/nazwy.	jQuery.Odroczone	args (obiekt): argumenty opisujące pary setting-path/name. useCache (wartość logiczna): użyj pamięci podręcznej zamiast bezpośredniego wykonywania zapytań względem serwera. readThroughCache (wartość logiczna): pobierz z usługi ustawień, jeśli ustawienia nie są obecne w pamięci podręcznej.
Shell.Configuration.initialize	Inicjuje pamięć podręczną konfiguracji.	jQuery.Odroczone	Brak.
Shell.Configuration.updateLoadedUserSettings	Aktualizacje wartości ustawień użytkownika, które zostały wcześniej załadowane wstępnie.	jQuery.Odroczone	args (obiekt): argumenty opisujące ustawienia do zaktualizowania. delaySyncWithService (wartość logiczna): opóźnienie zapisywania w usłudze ustawień użytkownika przez 5 sekund po najnowszej aktualizacji w celu zmniejszenia liczby rozmów sieciowych.
Shell.Configuration.updateUserSetting	Aktualizacje ustawienie pojedynczego użytkownika.	jQuery.Odroczone	setting (Object): Ustawienia do aktualizacji. Jedna z nich[ 0] jest aktualizowana. wartość (ciąg): klucze do usunięcia.
Shell.Configuration.updateUserSettings	Aktualizacje ustawień użytkownika.	jQuery.Odroczone	args (obiekt): argumenty opisujące ustawienia do zaktualizowania. updateCache (wartość logiczna): Aktualizacje pamięci podręcznej oprócz aktualizowania ustawień w usłudze ustawień.

Przykłady

Pobierz ustawienia użytkownika:

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

Utwórz lub zmień wartość ustawienia użytkownika:

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

Usuń ustawienie użytkownika:

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

Zobacz też

dokumentacja biblioteki powłoki rozszerzeń Windows Azure Pack