Shell.Utilities.js

 

Se aplica a: Windows Azure Pack

Contiene un conjunto de métodos de utilidad general.

Widgets

Ninguno.

Tipos

Shell.Promise(init, cancel)

Una promesa proporciona un mecanismo para programar el trabajo que se va a realizar en un valor que aún no se ha calculado. Es una abstracción cómoda para administrar interacciones con API asincrónicas.

Nombre	Tipo	Descripción
init	Función	Función a la que se llama durante la construcción de la promesa. La función recibe tres argumentos (completado, error, progreso).
cancel	Función	Opcional. Función para llamar a si un consumidor de flujo descendente de esta promesa quiere intentar cancelar su trabajo de deshacer. No es necesario cancelar las promesas.

Propiedades

Ninguno.

Métodos

Nombre	Descripción	Devuelve	Parámetros
Shell.Promise.addEventListener	Agrega un agente de escucha de eventos al control .	Nada	eventType: tipo (nombre) del evento. agente de escucha: el agente de escucha que se va a invocar cuando se genera el evento. capture: especifica si se va a iniciar la captura.
Shell.Promise.any	Devuelve una promesa que se cumple cuando se ha cumplido una de las promesas de entrada.	Promise	valores (Matriz): matriz de valores que incluyen objetos Promise o Object cuyos valores de propiedad incluyen objetos Promise.
Shell.Promise.as	Devuelve una promesa, si el valor ya es una promesa, se devuelve de lo contrario, el valor se ajusta en una promesa.	Promise	Valor: valor que se va a tratar como una promesa.
Shell.Promise.cancel	Intenta cancelar la realización de un valor prometido. Si la promesa aún no se ha cumplido y se admite la cancelación, la promesa entrará en el estado de error con un valor de error nuevo("Cancelado").	Nada	None
Shell.Utilities.deepEquals	Compara dos objetos profundamente y devuelve true si son iguales. Compara dos matrices profundamente y devuelve true si son iguales.	Boolean	a (Objeto): b (Objeto): a (Matriz): b (Matriz):
Shell.Promise.dispatchEvent	Genera un evento del tipo especificado y con propiedades adicionales. Devuelve true si se llamó a preventDefault en el evento .	Boolean	eventType: tipo (nombre) del evento. Detalles: conjunto de propiedades adicionales que se van a adjuntar al objeto de evento cuando se genera el evento.
Shell.Utilities.download	Descarga contenido en el explorador. El objeto devuelto es el iFrame que hospedará la descarga.	Object	URI (Cadena): URI del contenido que se va a descargar
Shell.Utilities.getAntiForgeryId	Obtiene el identificador del token antifalsificación.	String	None
Shell.Promise.is	Determine si un valor cumple el contrato promise. True se devuelve si el valor es promise.	Boolean	Valor: valor que puede ser una promesa.
Shell.Promise.join	Crea una promesa que se cumple cuando se realizan todos los valores. Return es una promesa cuyo valor es un registro con los mismos nombres de campo que la entrada donde cada campo es un valor realizado.	Promise	valores (Objeto): registro cuyos campos contienen valores, algunos de los cuales pueden ser Promesas.
Shell.Utilities.newGuid	Devuelve un NUEVO GUID.	String	None
Shell.Promise.removeEventListener	Quita un agente de escucha de eventos del control .	Nada	eventType: tipo (nombre) del evento. Agente de escucha: agente de escucha que se va a quitar de la lista de invocación. Capture: especifica si se va a iniciar la captura.
Shell.Promise.then	Reenviador estático al método de instancia promise then(). Devuelve Promise cuyo valor será el resultado de ejecutar la función proporcionada.	Promise	complete (Función): función a la que se llamará si la promesa se cumple correctamente con un valor. Si es null, la promesa proporcionará una implementación predeterminada que simplemente devuelve el valor. El valor se pasará como argumento único. error (Función): función a la que se llamará si se cumple la promesa con un error. El error se pasará como argumento único. progress (Función): función a la que se va a llamar si la promesa informa del progreso. Los datos sobre el progreso se pasarán como argumento único. Las promesas no son necesarias para admitir el progreso.
Shell.Promise.thenEach	Realiza una operación en todas las promesas de entrada y devuelve una promesa que está en la forma de la entrada y contiene el resultado de la operación que se ha realizado en cada entrada. Devuelve una promesa que es el resultado de llamar a Promise.Join en los valores de parámetro.	Promise	complete (Función): función a la que se llamará si la promesa se cumple correctamente con un valor. Si es null, promise proporcionará una implementación predeterminada que simplemente devuelve el valor. El valor se pasará como argumento único. error (Función): función a la que se llamará si se cumple la promesa con un error. El error se pasará como argumento único. progress (Función): función a la que se va a llamar si la promesa informa del progreso. Los datos sobre el progreso se pasarán como argumento único. Las promesas no son necesarias para admitir el progreso.
Shell.Promise.timeout	Cree una promesa que se cumpla después del período de tiempo de espera proporcionado. Devuelve una promesa que se completa de forma asincrónica después de los milisegundos indicados por el tiempo de espera.	Shell.Promise	timeout (Number): período de tiempo de espera, si 0 o no se especifica, se implementa mediante msSetImmediate; de lo contrario, se usa setTimeout.
Shell.Promise.wrap	Encapsular un valor que no sea Promise en una promesa, esto es útil si necesita pasar un valor a una función que requiere una promesa. Devuelve una promesa que se cumple correctamente con el valor especificado.	Shell.Promise	Valor: un valor que no es Promise que se va a encapsular en una promesa.
Shell.Promise.wrapError	Encapsular un valor de error que no sea Promise en una promesa, esto resulta útil si necesita pasar un error a una función que requiere una promesa. Devuelve una promesa que se cumple en un estado de error con el valor especificado.	Shell.Promise	Error: error que no es de promesa que se va a encapsular en una promesa.

Consulte también

Referencia de la biblioteca de Shell de extensión de azure Pack de Windows