---
name: "Eliom_client.client"
section: "3o"
platform: "linux"
package: "libeliom-ocaml-doc"
version: "2.2.2-1"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/Eliom_client.client"
---

# Eliom\_client.client(3o)

Call server side services and change the current page.

## NAME

Eliom\_client - Call server side services and change the current page.

## Module

Module   Eliom\_client

## 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