Module

Documentation

Module Eliom_client
 :  sig end

Call server side services and change the current page.

val change_page : ?absolute:bool -> ?absolute_path:bool -> ?https:bool -> service:('a, 'b, [< Eliom_service.service_kind ], [< Eliom_service.suff ], 'c, 'd, [< Eliom_service.registrable ], Eliom_registration.appl_service) Eliom_service.service -> ?hostname:string -> ?port:int -> ?fragment:string -> ?keep_nl_params:[ `All | `None | `Persistent ] -> ?nl_params:Eliom_parameter.nl_params_set -> ?keep_get_na_params:bool -> 'a -> 'b -> unit Lwt.t

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.

val call_caml_service : ?absolute:bool -> ?absolute_path:bool -> ?https:bool -> service:('a, 'b, [< Eliom_service.service_kind ], [< Eliom_service.suff ], 'c, 'd, [< Eliom_service.registrable ], 'e Eliom_parameter.caml) Eliom_service.service -> ?hostname:string -> ?port:int -> ?fragment:string -> ?keep_nl_params:[ `All | `None | `Persistent ] -> ?nl_params:Eliom_parameter.nl_params_set -> ?keep_get_na_params:bool -> 'a -> 'b -> 'e Lwt.t

Call a server side service that return an OCaml value.

val exit_to : ?absolute:bool -> ?absolute_path:bool -> ?https:bool -> service:('a, 'b, [< Eliom_service.service_kind ], [< Eliom_service.suff ], 'c, 'd, [< Eliom_service.registrable ], [< Eliom_registration.non_caml_service ]) Eliom_service.service -> ?hostname:string -> ?port:int -> ?fragment:string -> ?keep_nl_params:[ `All | `None | `Persistent ] -> ?nl_params:Eliom_parameter.nl_params_set -> ?keep_get_na_params:bool -> 'a -> 'b -> unit

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 \r\n .

val window_open : window_name:Js.js_string Js.t -> ?window_features:Js.js_string Js.t -> ?absolute:bool -> ?absolute_path:bool -> ?https:bool -> service:('a, unit, [< Eliom_service.get_service_kind ], [< Eliom_service.suff ], 'b, unit, [< Eliom_service.registrable ], 'c) Eliom_service.service -> ?hostname:string -> ?port:int -> ?fragment:string -> ?keep_nl_params:[ `All | `None | `Persistent ] -> ?nl_params:Eliom_parameter.nl_params_set -> ?keep_get_na_params:bool -> 'a -> Dom_html.window Js.t

Loads an Eliom service in a window (cf. Javascript's window.open ).

val call_service : ?absolute:bool -> ?absolute_path:bool -> ?https:bool -> service:('a, 'b, [< Eliom_service.service_kind ], [< Eliom_service.suff ], 'c, 'd, [< Eliom_service.registrable ], 'e) Eliom_service.service -> ?hostname:string -> ?port:int -> ?fragment:string -> ?keep_nl_params:[ `All | `None | `Persistent ] -> ?nl_params:Eliom_parameter.nl_params_set -> ?keep_get_na_params:bool -> 'a -> 'b -> string Lwt.t

(low level) Call a server side service and return the content of the resulting HTTP frame as a string.

val wait_load_end : unit -> unit Lwt.t

wait for the loading phase to terminate

val in_onload : unit -> bool

true if the function is executed inside the loading phase

val on_unload : (unit -> unit) -> unit

register a function to be called on page change