jsdoc servidor

servidor

Gestor de comunicación cliente<->servidor.

Métodos

establecerPredeterminados(opciones)

Establece las opciones predeterminadas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
opciones	*	Opciones. Ver documentación de invocarMetodo().

Devuelve: servidor

establecerUrl(url)

Establece la URL para las próximas consultas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
url	string

Devuelve: servidor

abortarTodo()

Aborta todas las solicitudes en curso.
Devuelve: servidor

invocarMetodo([opciones])

Invoca un método en un controlador de servidor.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
opciones	Object	Parámetros de la solicitud.	Si

Propiedades de opciones

Propiedad	Tipo	Descripción	Opcional	Predeterminado
metodo	Object	Nombre del método.	Si
aplicacion	Object	Nombre del método del controlador principal de la aplicación (clase pública). Equivalente a establecer metodo con controlador=null.	Si
foxtrot	Object	Nombre del método interno de Foxtrot.	Si
controlador	Object	Nombre del controlador. Por defecto, el controlador principal actual.	Si
modulo	Object	Nombre del Módulo.	Si
componente	Object	Nombre del componente.	Si
controladorOrigen	Object	Nombre del controlador que origina la solicitud.	Si
retorno	function	Función de retorno. Recibirá como único parámetro el valor recibido del servidor. No será invocada si el método no tuvo un valor de retorno.	Si
error	function	Función de error. Por defecto, será invocado el evento errorServidor.	Si	function
listo	function	Función a invocar tras la solicitud (siempre será invocada, independientemente del valor de retorno, excepto en caso de error).	Si
siempre	function	Función a invocar tras la solicitud (siempre será invocada, incluso en caso de error).	Si
parametros	Object	Parámetros o argumentos a enviar. Acepta instancias de File o Blob solo cuando opciones.formulario es true.	Si
abortar	Object	Determina si se deben abortar otras solicitudes en curso.	Si	true
precarga	Object	Determina si se debe mostrar la animación de precarga. Posibles valores: true (precarga normal a pantalla completa), "barra" (barra de progreso superior que no bloquea la pantalla), false (solicitud silenciosa).	Si	true
formulario	boolean	Envía la solicitud como datos de formulario (FormData).	Si	false
progreso	function	Función de notificación de progreso. Recibirá el progreso de 0 a 1 como argumento.	Si
tiempo	number	Tiempo límite (si se omite, será el valor por defecto de ajax).	Si
archivos	Object[]	Archivos a enviar. Debe ser un array de objetos { datos:File o Blob, nombre:"nombre" }. Solo tendrá efecto cuando opciones.formulario sea true.	Si

Devuelve: Ajax

establecerOpcionesProximaConsulta(opciones)

Establece opciones a ser utilizadas únicamente en la consulta inmediatamente siguiente.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
opciones	Object

Devuelve: servidor

evaluarRespuesta(resp,opciones)

Evalúa y ejecuta la respuesta recibida desde el servidor.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
resp	string	Respuesta recibida.
opciones	Object	Opciones establecidas al iniciar la solicitud.

Devuelve: servidor

fabricar([controlador,controladorOrigen])

Genera una instancia de una clase que redirigirá todas las llamadas a métodos al controlador de servidor especificado.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
controlador	string	Nombre del controlador, o null.	Si	null
controladorOrigen	string|Controlador	Instancia o nombre del controlador que está fabricando la instancia.	Si

Devuelve: Proxy

establecerPredeterminados(opciones)

Establece las opciones predeterminadas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
opciones	*	Opciones. Ver documentación de servidor.invocarMetodo().

Devuelve: *

establecerOpcionesProximaConsulta(opciones)

Establece opciones a ser utilizadas únicamente en la consulta inmediatamente siguiente.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
opciones	Object

Devuelve: *

preparar(..metodos)

Permite establecer los nombres de los métodos de servidor que utilizará el controlador, por compatibilidad con ES5.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
..metodos	string	Nombres de métodos.

Devuelve: *