Index of values

action_link_handler userid_o activation_key () is the handler for activation keys.

A GET service for action link keys.

add_email_handler () email adds a new e-mail address for the current user and sends an activation link.

A POST service to add an email to a user.

avatar user creates an image HTML tag (with Eliom_content.HTML.F) with an alt attribute to "picture" and with class "os-avatar".

avatar_of_user user returns the avatar of the user user as Some avatar_uri.

avatar_uri_of_avatar ?absolute_path avatar returns the URI (absolute or relative) depending on the value of absolute_path) of the avatar avatar.

avatar_uri_of_user user returns the avatar URI (absolute or relative) depending on the value of absolute_path) of the avatar of the user user.

Return a box containing a tip, to be inserted where you want in a page.

Display tips in pages, as a speech bubble.

check_password_confirmation ~password ~confirmation adds a listener to the element confirmation which checks if the value of password and confirmation match.

Confirm validation code and add extra phone to account of the currently connected user

confirm_code_extra_handler () number is like confirm_code_signup_handler but for adding an additional number to the account.

Confirm SMS activation code and (if valid) add new phone number to user's account.

Confirm validation code and recover account.

confirm_code_recovery_handler () number is like confirm_code_signup_handler but for recovering a lost password.

Confirm SMS activation code and (if valid) allow the user to set a new password.

Temporary alternate name for confirm_code_recovery_handler to facilite the transition.

Confirm validation code and complete sign-up with the phone number.

confirm_code_signup_handler () (first_name, (last_name, (pass, number))) sends a verification code to number, displays a popup for confirming the code, and creates the account if all goes well.

Confirm SMS activation code and (if valid) register new user.

connect_form ?a ?email () creates a POST login form with email, password, a checkbox to stay logged in (with default text to "keep me logged in" in a span) and a submit button.

connect_handler () ((login, password), keepMeLoggedIn) connects the user with login and password and keeps the user logged in between different session if keepMeLoggedIn is set to true.

A POST service to connect a user with username and password.

Same as Os_session.Opt.connected_fun but instead of failing in case the user is not connected, the function given as parameter takes an Os_types.User.id option for user id.

Wrapper for service handlers that fetches automatically connection information.

Wrapper for pages that first checks if the user is connected.

Wrapper for pages that first checks if the user is connected.

Same as Os_session.Opt.connected_rpc but instead of failing in case the user is not connected, the function given as parameter takes an Os_types.User.id option for user id.

Wrapper for server functions (see Os_session.connected_fun).

An userbox (in a div with the CSS class "connected-user-box") for connected users with an icon and the username.

Wrapper for server functions when you do not need userid (see Os_session.connected_fun).

A box (in a div with the CSS class "os-connection-box") with a sign in and a sign out button.

Specifies a page with an optional title (with the argument ?title), some optional extra metadata (with the argument ?head) and a given body.

css (same as js but for style sheet files).

Return "os-platform" where platform is the device platform.

default_connected_error_page userid_o get_param post_param exn is the default error page for connected pages.

default_connected_predicate userid_o get_param post_param is the default predicate for connected pages.

default_error_page get_param post_param exn is the default error page.

default_predicate get_param post_param is the default predicate.

Disable auto-initialization

Close a session by discarding server side states for current browser (session and session group), current client process (tab) and current request.

Close all sessions of current user.

Link to disconnect all user sessions.

disconnect_button ?a () creates a disconnect POST form with a button without value, a signout icon and a text message "logout".

disconnect_handler ?main_page () () disconnects the current user.

A link to Os_services.disconnect_service.

A POST service to disconnect the current user.

firstname_of_user user returns the first name of the user user

forgot_password_form ~a () creates a Os_user_view.generic_email_form with the service Os_services.forgot_password_service.

A POST service when the user forgot his password.

Retrieve the full name of user (which is the concatenation of the first name and last name).

generic_email_form ?a ?label ?text ?email ~service () creates an email POST form with an input of type email and a submit button.

Return the platform as a type Os_platform.t.

get_current_user () returns the current user as a Os_types.User.t option type.

get_current_user () returns the current user as a Os_types.User.t type.

get_current_userid () returns the ID of the current user as an option.

get_current_userid () returns the ID of the current user.

get_data userid returns the user which has ID userid.

get_data_from_cache userid returns the user with ID userid saved in cache.

home_button ~a () creates an input button with value "home" which redirects to the main service.

information_form ~a ~firstname ~lastname ~password1 ~password2 () creates a POST form to update the user information like first name, last name and password.

is_complete user returns true if the first name and the last name of Os_types.user have been completed yet.

js corresponds to the JavaScript files to include into each page.

language_of_user user returns the language of the user user

lastname_of_user user returns the last name of the user user

Use local_css instead of css for local stylesheets if you are building a mobile application.

Convert a CalendarLib.Calendar.t value to a local_calendar value.

Use local_js instead of js for local scripts if you are building a mobile application.

Convert a local_calendar value to a CalendarLib.Calendar.t value.

lwt_bound_input_enter inp f calls f whenever the user submits the contents of inp.

lwt_bound_input_enter f produces an input element bound to f, i.e., when the user submits the input, we call f.

The main service.

Builds a valid html page from body content by adding headers for this app

memoizator f () caches the returned value of f ()

Call this function either from client or server side to display an error message in the page.

now () returns the current date as a local_calendar value.

other_head is a list of custom elements to add in the head section.

Default wrapper for service handler generating pages.

password_form ~a ~service () defines a POST form with two inputs for a password form (password and password confirmation) and a send button.

preregister_form ~a label creates a Os_user_view.generic_email_form with the service Os_services.preregister_service and add the label label to the email input form.

A POST service to preregister a user.

Register the settings service (defined in the app rather than in the OS lib) because we need to perform redirections to it.

reload () reloads the current page.

remove_email_from_user email removes the email email of the current user.

Send a validation code for a new e-mail address (corresponds to confirm_code_signup and confirm_code_extra).

Send a validation code for recovering an existing address.

Call this function to reset tips for current user.

Link to start to see the help from the beginning.

A non-attached service that will reset tips.

restart ?url () restarts the client and redirects to the url url.

restart_process () restarts the client.

set_password_rpc (password, confirmation_password) is a RPC to set_password.

A POST service to update the password.

A POST service to update the basic user data like first name, last name and password.

Call this function to mark a tip as "already seen" by current user.

sign_up_form ?a ?email () creates a Os_user_view.generic_email_form with the service Os_services.sign_up_service.

sign_up_handler () email signes up an user with email email.

A POST service to sign up with only an email address.

smart_date ~now local_date returns a smart description of local_date comparing to now (default value of now is the current time when the function is called).

smart_date_interval ?now start_date end_date returns a smart description of start_date comparing to end_date of the year, month and day (compared to Os_date.smart_interval, no information about the hour and minutes is given).

smart_hours_minutes date returns the time in the format "%I:%M%P".

smart_interval ?now start_date end_date returns a smart description of start_date comparing to end_date of the year, month, day, hour and minutes (compared to Os_date.smart_date_interval, information about the hour and minutes is given).

smart_time ~now date returns a smart description of local_date comparing to now (default value of now is the current time when the function is called).

Returns whether a tip has been seen or not.

title corresponds to the html tag <title>, it will be inserted on all pages.

Convert any type of calendar to a local calendar.

Convert a local_calendar value to a CalendarLib.Date.t value.

Convert a local_calendar value to a CalendarLib.Time.t value.

Convert a local calendar to a UTC calendar

unknown_timezone () returns true if the timezone is unknown.

Counterpart of set_tip_seen.

update_language language updates the language of the current user.

A POST service to update the language of the current user.

update_main_email email sets the main email of the current user to email.

upload_pic_link ?a ?content ?crop ?input ?submit action_after_submit service userid

Return Os_user_view.connection_box if no user is connected (i.e.

user_tz () returns current user's timezone.

userid_of_user user returns the userid of the user user.

username user creates a div with class "os_username" containing: firstname lastname if the user has a firstname., "User " concatenated with the userid in other cases. FIXME/IMPROVEME: use an option for the case the user has no firstname? Firstname must be empty because it must be optional.