Shell.Utilities.js

 

Gäller för: Windows Azure Pack

Innehåller en uppsättning allmänna metoder.

Widgets

Inga.

Typer

Shell.Promise(init, cancel)

Ett löfte tillhandahåller en mekanism för att schemalägga arbete som ska utföras på ett värde som ännu inte har beräknats. Det är en praktisk abstraktion för att hantera interaktioner med asynkrona API:er.

Namn	Typ	Beskrivning
init	Funktion	Funktion som anropas under byggandet av Promise. Funktionen ges tre argument (fullständig, fel, förlopp).
avbryt	Funktion	Valfritt. Funktion för att anropa om en nedströmskonsument av det här löftet vill försöka avbryta det ångrade arbetet. Löften behöver inte vara avbrutna.

Egenskaper

Inga.

Metoder

Name	Beskrivning	Returer	Parametrar
Shell.Promise.addEventListener	Lägger till en händelselyssnare i kontrollen.	Ingenting	eventType: Typen (namnet) på händelsen. lyssnare: Lyssnaren som ska anropas när händelsen aktiveras. capture: Anger om avbildningen ska initieras eller inte.
Shell.Promise.any	Returnerar ett löfte som uppfylls när ett av indatalöftena har uppfyllts.	Löfte	values (Array): Matris med värden, inklusive Promise-objekt eller Objekt vars egenskapsvärden inkluderar Promise-objekt.
Shell.Promise.as	Returnerar ett löfte, om värdet redan är ett löfte returneras det annars omsluts värdet i ett löfte.	Löfte	Värde: Värde som ska behandlas som ett löfte.
Shell.Promise.cancel	Försöker avbryta genomförandet av ett utlovat värde. Om promise inte redan har uppfyllts och annullering stöds kommer Promise att ange feltillståndet med värdet nytt Fel("Avbryts").	Ingenting	Ingen
Shell.Utilities.deepEquals	Jämför två objekt djupt och returnerar sant om de är lika med. Jämför två matriser djupt och returnerar sant om de är lika med.	Boolesk	a (objekt): b (objekt): a (matris): b (matris):
Shell.Promise.dispatchEvent	Genererar en händelse av den angivna typen och med ytterligare egenskaper. Returnerar sant om preventDefault anropades för händelsen.	Boolesk	eventType: Typen (namnet) på händelsen. Information: Uppsättningen ytterligare egenskaper som ska kopplas till händelseobjektet när händelsen aktiveras.
Shell.Utilities.download	Laddar ned innehåll till webbläsaren. Det returnerade objektet är den iFrame som ska vara värd för nedladdningen.	Objekt	uri (sträng): URI för innehållet som ska laddas ned
Shell.Utilities.getAntiForgeryId	Hämtar token-ID:t för förfalskning.	Sträng	Ingen
Shell.Promise.is	Avgöra om ett värde uppfyller Promise-kontraktet. Sant returneras om värdet är ett löfte.	Boolesk	Värde:Ett värde som kan vara ett löfte.
Shell.Promise.join	Skapar ett löfte som uppfylls när alla värden realiseras. Retur är ett löfte vars värde är en post med samma fältnamn som indata där varje fält är ett realiserat värde.	Löfte	values (Object): Record vars fält innehåller värden, varav vissa kan vara Promises.
Shell.Utilities.newGuid	Returnerar nytt GUID.	Sträng	Ingen
Shell.Promise.removeEventListener	Tar bort en händelselyssnare från kontrollen.	Ingenting	eventType: Typen (namnet) på händelsen. Lyssnare: Lyssnaren som du vill ta bort från anropslistan. Avbildning: Anger om avbildningen ska initieras eller inte.
Shell.Promise.then	Statisk vidarebefordrare till promise-instansmetoden then(). Returnerar Promise vars värde kommer att vara resultatet av att köra den angivna funktionen.	Löfte	complete (Function): Funktion som ska anropas om promise uppfylls med ett värde. Om värdet är null ger Promise en standardimplementering som helt enkelt returnerar värdet. Värdet skickas som det enda argumentet. error (Function): Funktion som ska anropas om Promise uppfylls med ett fel. Felet skickas som ett enda argument. progress (Function): Funktion som ska anropas om Promise rapporterar förloppet. Data om förloppet skickas som det enskilda argumentet. Löften krävs inte för att stödja förloppet.
Shell.Promise.thenEach	Utför en åtgärd på alla indatalöften och returnerar ett promise som är i form av indata och innehåller resultatet av att åtgärden har utförts på varje indata. Returnerar ett promise som är resultatet av anropet Promise.Join i parametervärdena.	Löfte	complete (Function): Funktion som anropas om promise uppfylls med ett värde. Om värdet är null ger Promise en standardimplementering som helt enkelt returnerar värdet. Värdet skickas som det enskilda argumentet. error (Function): Funktion som anropas om Promise uppfylls med ett fel. Felet skickas som det enda argumentet. progress (Function): Funktion som ska anropas om Promise rapporterar förloppet. Data om förloppet skickas som det enskilda argumentet. Löften krävs inte för att stödja förloppet.
Shell.Promise.timeout	Skapa ett löfte som uppfylls efter den angivna tidsgränsperioden. Returnerar ett promise som slutförs asynkront efter de millisekunder som anges av tidsgränsen.	Shell.Promise	timeout (tal): Tidsgräns, om 0 eller inte anges, implementeras detta med hjälp av msSetImmediate, annars med setTimeout.
Shell.Promise.wrap	Omsluta ett icke-Promise-värde i ett löfte är detta användbart om du behöver skicka ett värde till en funktion som kräver ett löfte. Returnerar ett promise som har uppfyllts med det angivna värdet.	Shell.Promise	Värde: Ett värde som inte är ett löfte för att omsluta ett löfte.
Shell.Promise.wrapError	Omsluta ett icke-Promise-felvärde i ett löfte är detta användbart om du behöver skicka ett fel till en funktion som kräver ett löfte. Returnerar ett promise som uppfylls i ett feltillstånd med det angivna värdet.	Shell.Promise	Fel: Ett icke-promise-fel som ska omslutas i ett promise.

Se även

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