Index of values

Reference used to remember if the account is activated.

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

Set to true if an action link key has been already created and sent to the user email, else false.

Reference used to remember if an action link key is outdated.

A GET service for action link keys.

add userid number associates number with the user userid.

add_actionlinkkey ?autoconnect ?action ?data ?validity ?expiry ~act_key ~userid ~email () adds the action key in the database.

Add two buttons with an action (created with Os_fcm_notif.Data.PhoneGap.Action.create).

Add a badge to the icon of the notification in the launcher.

add_badge nb_badge notification indicates the badge on the client app home icon.

add_body body notification adds a body to the notification

add_click_action activity notification adds an action when the user taps on the notification.

add_collapse_key collapse_key options identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed.

add_color ~red ~green ~blue notification indicates color of the icon, expressed in #rrggbb format.

add_condition condition options specifies a logical expression of conditions that determine the message target.

add_content_available value options.

add_dry_run value options.

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.

add_email_to_user ~userid ~email add email to user with ID userid.

add_icon icon notification indicates notification icon.

Add an image to the push notification in the notification area

Add content-available: 1 also

Change the LED color when the notification is received.

Add a message attribute to the notification

Add a notification ID.

Add a large picture in the notification (under the title and body).

add_preregister email adds an email into the preregister collections.

add_preregister email preregisters email in the database.

add_priority priority options sets the priority of the message.

add_raw_json key content_json data

add_raw_json key content_json data

add_raw_json key content_json notification

add_raw_string key content data

add_raw_string key content data

add_raw_string key content notification

add_restricted_package_name package_name options specifies the package name of the application where the registration tokens must match in order to receive the message.

add_sound sound notification indicates a sound to play when the device receives a notification.

Add a soundame when the mobile receives the notification

Add a summary text.

add_tag tag notification indicates whether each notification results in a new entry in the notification drawer on Android.

add_time_to_live time_in_seconds options specifies how long (in seconds) the message should be kept in FCM storage if the device is offline.

Add a title attribute to the notification

add_title title notification adds a title to push notification in the notification area.

add_to to options specifies the recipient of a message.

add_user_in_group ~group ~userid adds the user with ID userid to group.

add_user_in_group ~groupid ~userid adds the user with ID userid in the group with ID groupid

Add a vibration pattern

Add the visibility payload

Get limit (default: 10) emails from the preregister collections.

all () returns all the groups of the database.

all () returns all groups as list of tuple (groupid, name, description).

all ?limit () get all email addresses with a limit of limit (default is 10).

available email returns true if email is not already used.

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.

Cache keeping userid and user information as a Os_types.user type.

canonical_ids_of_t response returns the number of results that contain a canonical registration token.

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

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 validation code and create corresponding user.

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

Close current session (if any) by calling disconnect, then open a new session for a user by setting a session group for the browser which initiated the current request.

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.

Direct access to the connection pool

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

create ?password ?avatar ?language ~firstname ~lastname email creates a new user with the given information.

create ~description name creates a new group in the database and returns it as a record of type Os_types.Group.t.

create registered_ids creates a new option where registered_ids is the ID of mobile devices you want to send the notifications to.

create icon title callback foreground

create ?description name creates a new group with name name and with description description.

create ?password ?avatar ?language ~firstname ~lastname email creates a new user in the database and returns the userid of the new user.

crop_image ~src ?dst ?ratio ~top ~right ~bottom ~left crops the image saved in src and saves the result in dst (default is the source file).

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.

delete userid number deletes number, which has to be associated to userid.

desc_of_group group returns the group description.

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 (or userid if present).

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.

email_of_user user returns the main email of user user.

email_of_userid userid returns the main email of user with ID userid.

email_of_userid userid returns the main email registered for the user with ID userid.

The pattern used to check the validity of an e-mail address.

emails_of_user user returns the emails list of user user.

emails_of_userid userid returns the emails list of user with ID userid.

emails_of_userid userid returns all emails registered for the user with ID userid.

Like emails_of_userid, but also returns validation status.

empty () creates an empty data value.

empty () creates an empty notification

Does the number exist in the database?

failure_of_t response returns the number of messages that could not be processed.

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.

forgot_password_handler service () email creates and sends an action link to email if the user forgot his password and redirects to service.

A POST service when the user forgot his password.

full_transaction_block f executes function f within a database transaction.

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.

Get the value corresponding to the given key.

Retrieve the data corresponding to an action link key, each call decrements the validity of the key by 1 if it exists and validity > 0 (it remains at 0 if it's already 0).

get_actionlinkkey_info key returns the information about the action link key as a type Os_types.Action_link_key.info.

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.

get_data_from_db myid_o userid returns the user which has ID userid.

get_data_from_db_for_client myid_o userid returns the user which has ID userid.

Return the height of the given image.

Return the width of the given image.

get_language userid returns the language of the user with ID userid.

get_language userid returns the language of the user with ID userid

get_list userid returns the list of number associated to the user.

get_mailer () returns the name of mailer program.

get_users ?pattern () gets users who match the pattern (useful for completion).

get_users ~pattern () returns all users matching the pattern pattern as a tuple (userid, firstname, lastname, avatar, bool_password, language).

Overwrites the function group_of_name of Os_db.Group and use the get function of the cache module.

group_of_name name returns a tuple (groupid, name, description) describing the group.

Returns true if the key has been stored into the cache.

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

id_of_group group returns the group ID.

in_group ~group ~userid returns true if the user with ID userid is in group.

in_group ~groupid ~userid returns true if the user with ID userid is in the group with ID groupid.

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

init ?host ?port ?user ?password ?database ?unix_domain_socket_dir ?init () initializes the variables for the database access and register a function init invoked each time a connection is created.

You can use initialize timezone to communicate the client's timezone to the client when the auto-initialization is disabled

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

is_email_validated ~userid ~email returns whether for a user designated by its id the given email has been validated.

is_email_validated userid email returns true if email has been validated by the user with id userid.

is_email_validated email returns true if email is a valided email for the current user.

is_main_email ~userid ~email returns whether an email is the main email registered for a given user designated by its id.

is_main_email ~email ~userid returns true if the main email of the user with ID userid is email.

is_main_email email returns true if email is the main email of the current user.

is_preregistered email returns true if a user exists with email email.

is_preregistered email returns true if email is already registered.

is_registered email returns true if a user exists with email email.

is_registered email returns true if the email is already registered.

is_valid email returns true if the e-mail address email is valid.

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 ()

message_id_of_success success returns a string specifying a unique ID for each successfully processed message.

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

multicast_id_of_t response returns the unique ID identifying the multicast message.

name_of_group group returns the group name.

Reference used to remember if a wrong user has already been typed.

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

Call this to add an action to be done at each connected request.

Call this to add an action to be done just for each denied request.

Call this to add an action to be done just after opening a session The function takes the user id as parameter.

Call this to add an action to be done just after closing the session

Call this to add an action to be done just before closing the session

Call this to add an action to be done just before handling a request

Call this to add an action to be done when the process starts in connected mode, or when the user logs in

Call this to add an action to be done on server side when the process starts

Call this to add an action to be done on server side when the process starts but only when not in connected mode

Call this to add an action to be done at each unconnected request.

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.

password_set userid returns true if the user with ID userid has set a password.

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.

preregister_handler () email preregisters the email email.

A POST service to preregister a user.

pwd_crypt_ref is a reference to (f_crypt, f_check) where f_crypt pwd is used to encrypt the password pwd., f_check userid pwd hashed_pwd returns true if the hash of pwd and the hashed password hashed_pwd of the user with id userid match. If they don't match, it returns false.

record_image directory ?ratio ?cropping:(top, right, bottom, left) file crops the image like crop_image and save it in the directory directory.

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

registration_id_of_t result returns a string specifying the canonical registration token for the client app that the message was processed and sent to.

remove_email_from_user ~userid ~email removes the email email from the user with the id userid.

remove_email_from_user ~userid ~email removes the email email from the emails list of user with ID userid.

remove_email_from_user email removes the email email of the current user.

remove_preregister email removes an email from the preregister collections.

remove_preregister email removes email from the database.

remove_user_in_group ~group ~userid removes the user with ID userid from group.

remove_user_in_group ~groupid ~userid removes the user with ID userid in the group with ID groupid

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.

Remove a value for the given key.

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.

Resize the given image (src) and save it to dst (default is the source file).

results_of_t response returns the status of the messages processed.

send server_key notification options

Send an e-mail to to_addrs from from_addr.

Set the corresponding value for a key.

Set default message duration (default 4s)

set_email_validated userid email valids email for the user with id userid.

set_from_addr (sender_name, sender_email) sets the email address used to send mail to sender_email and the sender name to sender_name.

set_mailer mailer sets the name of the external sendmail program on your system, used by the default Os_email.send function.

set_password_handler userid () (password, confirmation_password) updates the password of the user with ID userid with the hashed value of password if confirmation_password corresponds to password.

A POST service to update the password.

set_personal_data_handler userid () ((firstname, lastname), (password, confirmation_password)) sets the corresponding data to given values.

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

By default, passwords are encrypted using Bcrypt.

Customize email sending function.

set_send_sms_handler f registers f as the function to be called to send SMS messages.

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).

string_of_error error returns a string representation of the error error.

string_of_stream ?len stream creates a string of maximum length len (default is 16384) from the stream stream.

success_of_t response returns the number of messages that were processed without an error.

Returns whether a tip has been seen or not.

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

to_list option returns the representation of the options as a list of tuples (option_name, json_value).

to_list data returns the representation of the data as a list of tuples (data_key, json_value).

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.

Make a user stop listening on data key.

Counterpart of set_tip_seen.

update ?password ?avatar ?language ~firstname ~lastname userid update the given information of the user with ID userid.

update ?password ?avatar ?language ~firstname ~lastname userid updates the user profile with userid.

Another version of update using a type Os_types.User.t instead of label.

update_avatar ~userid ~avatar updates the avatar of the user with ID userid.

update_avatar ~userid ~avatar updates the avatar of the user with ID userid.

update_language ~userid ~language updates the language of the user with ID userid.

update_language ~userid ~language updates the language of the user with ID userid.

update_language language updates the language of the current user.

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

update_mail_email ~userid ~email sets the main email for a user with the ID userid as the email email.

update_main_email ~userid ~email updates the main email of the user with ID userid.

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

update_password ~userid ~password updates the password only.

update_password ~userid ~new_password updates the password of the user with ID userid.

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

Reference used to remember if the user already exists.

Reference used to remember if the user is already preregistered.

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

Reference used to remember if the user exists.

user_of_userid userid returns the information about the user with ID userid.

user_of_userid userid returns a tuple (userid, firstname, lastname, avatar, bool_password, language) describing the information about the user with ID userid.

user_tz () returns current user's timezone.

The user corresponding to a phone number (if any).

userid_of_email email returns the userid of the user with email email.

userid_of_email email returns the userid of the user which has the email email.

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.

verify_password ~email ~password returns the userid if user with email email is registered with the password password.

verify_password ~email ~password returns the userid if user with email email is registered with the password password.

verify_password_phone ~number ~password returns the userid if user who owns number and whose password is password.

without_transaction f executes function f outside a database transaction.

Reference used to remember if a wrong password has been already typed.

((firstname, lastname), (password, password_confirmation)) option is a reference used to remember information about the user during a request when something went wrong (for example in a form when the password and password confirmation are not the same).