.TH "Eliom_client" 3o 2012-06-11 OCamldoc ""
.SH NAME
Eliom_client \- Call server side services and change the current page.
.SH Module
Module   Eliom_client
.SH Documentation
.sp
Module
.BI "Eliom_client"
 : 
.B sig  end

.sp
Call server side services and change the current page\&.
.sp

.sp

.sp
.sp

.I val change_page 
: 
.B ?absolute:bool ->
.B   ?absolute_path:bool ->
.B   ?https:bool ->
.B   service:('a, 'b, [< Eliom_service.service_kind ], [< Eliom_service.suff ],
.B            'c, 'd, [< Eliom_service.registrable ],
.B            Eliom_registration.appl_service)
.B           Eliom_service.service ->
.B   ?hostname:string ->
.B   ?port:int ->
.B   ?fragment:string ->
.B   ?keep_nl_params:[ `All | `None | `Persistent ] ->
.B   ?nl_params:Eliom_parameter.nl_params_set ->
.B   ?keep_get_na_params:bool -> 'a -> 'b -> unit Lwt.t
.sp
Call a server side service and change the current page\&.
If the service belongs to the same application,
the client side program is not stopped, and only
the content (not the container) is reloaded\&.
.sp

.sp

.I val call_caml_service 
: 
.B ?absolute:bool ->
.B   ?absolute_path:bool ->
.B   ?https:bool ->
.B   service:('a, 'b, [< Eliom_service.service_kind ], [< Eliom_service.suff ],
.B            'c, 'd, [< Eliom_service.registrable ], 'e Eliom_parameter.caml)
.B           Eliom_service.service ->
.B   ?hostname:string ->
.B   ?port:int ->
.B   ?fragment:string ->
.B   ?keep_nl_params:[ `All | `None | `Persistent ] ->
.B   ?nl_params:Eliom_parameter.nl_params_set ->
.B   ?keep_get_na_params:bool -> 'a -> 'b -> 'e Lwt.t
.sp
Call a server side service that return an OCaml value\&.
.sp

.sp

.I val exit_to 
: 
.B ?absolute:bool ->
.B   ?absolute_path:bool ->
.B   ?https:bool ->
.B   service:('a, 'b, [< Eliom_service.service_kind ], [< Eliom_service.suff ],
.B            'c, 'd, [< Eliom_service.registrable ],
.B            [< Eliom_registration.non_caml_service ])
.B           Eliom_service.service ->
.B   ?hostname:string ->
.B   ?port:int ->
.B   ?fragment:string ->
.B   ?keep_nl_params:[ `All | `None | `Persistent ] ->
.B   ?nl_params:Eliom_parameter.nl_params_set ->
.B   ?keep_get_na_params:bool -> 'a -> 'b -> unit
.sp
Stop current program and load a new page\&.  Note that for string arguments,
sole line feed or sole carriage return characters are substituted by the
string 
.B "\(rsr\(rsn"
\&.
.sp

.sp

.I val window_open 
: 
.B window_name:Js.js_string Js.t ->
.B   ?window_features:Js.js_string Js.t ->
.B   ?absolute:bool ->
.B   ?absolute_path:bool ->
.B   ?https:bool ->
.B   service:('a, unit, [< Eliom_service.get_service_kind ],
.B            [< Eliom_service.suff ], 'b, unit, [< Eliom_service.registrable ],
.B            'c)
.B           Eliom_service.service ->
.B   ?hostname:string ->
.B   ?port:int ->
.B   ?fragment:string ->
.B   ?keep_nl_params:[ `All | `None | `Persistent ] ->
.B   ?nl_params:Eliom_parameter.nl_params_set ->
.B   ?keep_get_na_params:bool -> 'a -> Dom_html.window Js.t
.sp
Loads an Eliom service in a window (cf\&. Javascript\&'s 
.B window\&.open
)\&.
.sp

.sp

.I val call_service 
: 
.B ?absolute:bool ->
.B   ?absolute_path:bool ->
.B   ?https:bool ->
.B   service:('a, 'b, [< Eliom_service.service_kind ], [< Eliom_service.suff ],
.B            'c, 'd, [< Eliom_service.registrable ], 'e)
.B           Eliom_service.service ->
.B   ?hostname:string ->
.B   ?port:int ->
.B   ?fragment:string ->
.B   ?keep_nl_params:[ `All | `None | `Persistent ] ->
.B   ?nl_params:Eliom_parameter.nl_params_set ->
.B   ?keep_get_na_params:bool -> 'a -> 'b -> string Lwt.t
.sp
(low level) Call a server side service and return the content
of the resulting HTTP frame as a string\&.
.sp

.sp

.I val wait_load_end 
: 
.B unit -> unit Lwt.t
.sp
wait for the loading phase to terminate
.sp

.sp

.I val in_onload 
: 
.B unit -> bool
.sp
true if the function is executed inside the loading phase
.sp

.sp

.I val on_unload 
: 
.B (unit -> unit) -> unit
.sp
register a function to be called on page change
.sp

.sp