Shell.Utilities.js
Dotyczy: Windows Azure Pack
Zawiera zestaw metod ogólnego narzędzia.
Widżety
Brak.
Typy
Shell.Promise(init, cancel)
Obietnica zapewnia mechanizm planowania pracy, która ma być wykonywana na wartości, która nie została jeszcze obliczona. Jest to wygodna abstrakcja do zarządzania interakcjami z asynchronicznymi interfejsami API.
Nazwa |
Typ |
Opis |
---|---|---|
init |
Funkcja |
Funkcja wywoływana podczas budowy obietnicy. Funkcja otrzymuje trzy argumenty (complete, error, progress). |
Anuluj |
Funkcja |
Opcjonalny. Funkcja do wywołania, jeśli odbiorca strumienia w dół tej obietnicy chce spróbować anulować jego cofniętą pracę. Obietnice nie są wymagane do anulowania. |
Właściwości
Brak.
Metody
Nazwa |
Opis |
Zwraca |
Parametry |
---|---|---|---|
Shell.Promise.addEventListener |
Dodaje odbiornik zdarzeń do kontrolki. |
Nothing |
eventType: typ (nazwa) zdarzenia. odbiornik: odbiornik, który ma być wywoływany po wywołaniu zdarzenia. capture: określa, czy należy zainicjować przechwytywanie. |
Shell.Promise.any |
Zwraca obietnicę, która jest spełniona, gdy jedna z wprowadzania obietnic została spełniona. |
Obietnica |
values (Array): Tablica wartości, w tym obiekty Promise lub Obiekt, których wartości właściwości obejmują obiekty Promise. |
Shell.Promise.as |
Zwraca obietnicę, jeśli wartość jest już obietnicą, jest zwracana w przeciwnym razie wartość jest opakowana w obietnicę. |
Obietnica |
Wartość: wartość, która ma być traktowana jako obietnica. |
Shell.Promise.cancel |
Próbuje anulować realizację obiecanej wartości. Jeśli obietnica nie została jeszcze spełniona, a anulowanie jest obsługiwane, obietnica wprowadzi stan błędu z wartością nowego błędu("Anulowane"). |
Nothing |
Brak |
Shell.Utilities.deepEquals |
Porównuje dwa obiekty głęboko i zwraca wartość true, jeśli są równe. Porównuje dwie tablice głęboko i zwraca wartość true, jeśli są równe. |
Wartość logiczna |
a (Obiekt): b (obiekt): a (Tablica): b (Tablica): |
Shell.Promise.dispatchEvent |
Zgłasza zdarzenie określonego typu i z dodatkowymi właściwościami. Zwraca wartość true, jeśli funkcja preventDefault została wywołana w zdarzeniu. |
Wartość logiczna |
eventType: typ (nazwa) zdarzenia. Szczegóły: zestaw dodatkowych właściwości, które mają być dołączone do obiektu zdarzenia po wystąpieniu zdarzenia. |
Shell.Utilities.download |
Pobiera zawartość do przeglądarki. Zwrócony obiekt to element iFrame, który będzie hostował pobieranie. |
Obiekt |
URI (ciąg): identyfikator URI zawartości do pobrania |
Shell.Utilities.getAntiForgeryId |
Pobiera identyfikator tokenu ochrony przed fałszercją. |
Ciąg |
Brak |
Shell.Promise.is |
Ustal, czy wartość spełnia umowę Promise. Wartość True jest zwracana, jeśli wartość jest obietnicą. |
Wartość logiczna |
Value:Wartość, która może być obietnicą. |
Shell.Promise.join |
Tworzy obietnicę, która jest spełniona, gdy zostaną zrealizowane wszystkie wartości. Zwracana jest obietnica, której wartość jest rekordem o tych samych nazwach pól co dane wejściowe, w których każde pole jest wartością zrealizowaną. |
Obietnica |
values (Object): Rekord, którego pola zawierają wartości, z których niektóre mogą być obietnicami. |
Shell.Utilities.newGuid |
Zwraca nowy identyfikator GUID. |
Ciąg |
Brak |
Shell.Promise.removeEventListener |
Usuwa odbiornik zdarzeń z kontrolki. |
Nothing |
eventType: typ (nazwa) zdarzenia. Odbiornik: odbiornik do usunięcia z listy wywołań. Przechwytywanie: określa, czy należy zainicjować przechwytywanie. |
Shell.Promise.then |
Statyczny element przesyłania dalej do metody wystąpienia Promise to(). Zwraca wartość Promise, której wartość będzie wynikiem uruchomienia podanej funkcji. |
Obietnica |
complete (Funkcja): funkcja, która ma zostać wywołana, jeśli obietnica została pomyślnie spełniona z wartością. Jeśli wartość null, obietnica zapewni implementację domyślną, która po prostu zwraca wartość. Wartość zostanie przekazana jako pojedynczy argument. error (Funkcja): funkcja, która ma zostać wywołana, jeśli obietnica zostanie spełniona z powodu błędu. Błąd zostanie przekazany jako pojedynczy argument. progress (Funkcja): funkcja, która ma być wywoływana, jeśli postęp raportów Promise. Dane dotyczące postępu zostaną przekazane jako pojedynczy argument. Obietnice nie są wymagane do obsługi postępu. |
Shell.Promise.thenEach |
Wykonuje operację na wszystkich obietnicach wejściowych i zwraca obietnicę, która jest w kształcie danych wejściowych i zawiera wynik operacji, która została wykonana na poszczególnych danych wejściowych. Zwraca obietnicę, która jest wynikiem wywołania metody Promise.Join w wartościach parametrów. |
Obietnica |
complete (Funkcja): funkcja, która ma zostać wywołana, jeśli obietnica została pomyślnie spełniona z wartością. Jeśli wartość null, obietnica zapewni implementację domyślną, która po prostu zwraca wartość. Wartość zostanie przekazana jako pojedynczy argument. error (Funkcja): funkcja, która ma zostać wywołana, jeśli obietnica zostanie spełniona z powodu błędu. Błąd zostanie przekazany jako pojedynczy argument. progress (Funkcja): funkcja, która ma być wywoływana, jeśli postęp raportów Promise. Dane dotyczące postępu zostaną przekazane jako pojedynczy argument. Obietnice nie są wymagane do obsługi postępu. |
Shell.Promise.timeout |
Utwórz obietnicę, która zostanie spełniona po podanym przedziale czasu. Zwraca obietnicę, która jest ukończona asynchronicznie po milisekundach wskazanych przez limit czasu. |
Shell.Promise |
limit czasu (liczba): limit czasu, jeśli wartość 0 lub nie została określona, jest zaimplementowana przy użyciu funkcji msSetImmediate, w przeciwnym razie przy użyciu parametru setTimeout. |
Shell.Promise.wrap |
Zawijanie wartości innej niż obietnica jest przydatna, jeśli musisz przekazać wartość do funkcji, która wymaga obietnicy. Zwraca obietnicę, która została pomyślnie spełniona z określoną wartością. |
Shell.Promise |
Wartość: wartość innej niż obietnica opakowuje obietnicę. |
Shell.Promise.wrapError |
Zawijanie wartości błędu innego niż promise w obietnicy jest przydatne, jeśli musisz przekazać błąd do funkcji, która wymaga obietnicy. Zwraca obietnicę, która jest spełniona w stanie błędu z określoną wartością. |
Shell.Promise |
Błąd: Błąd inny niż obietnica, który ma zostać opakowany w obietnicę. |
Zobacz też
dokumentacja biblioteki powłoki rozszerzeń Windows Azure Pack