This is server API (go to client)

Warning: Reason support is experimental. We are looking for beta-tester and contributors.

Index of values


__link [Os_comet]

A
account_not_activated [Os_user]

Reference used to remember if the account is activated.

action_link_handler [Os_handlers]

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

action_link_key_created [Os_msg]

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

action_link_key_outdated [Os_user]

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

action_link_service [Os_services]

A GET service for action link keys.

add [Os_db.​Phone]

add userid number associates number with the user userid.

add_actionlinkkey [Os_user]

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

add_actionlinkkey [Os_db.​User]
add_actions [Os_fcm_notif.​Data.​PhoneGap]

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

add_badge [Os_fcm_notif.​Data.​PhoneGap]

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

add_badge [Os_fcm_notif.​Notification.​Ios]

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

add_body [Os_fcm_notif.​Notification]

add_body body notification adds a body to the notification

add_click_action [Os_fcm_notif.​Notification]

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

add_collapse_key [Os_fcm_notif.​Options]

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 [Os_fcm_notif.​Notification.​Android]

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

add_condition [Os_fcm_notif.​Options]

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

add_content_available [Os_fcm_notif.​Options]

add_content_available value options.

add_dry_run [Os_fcm_notif.​Options]

add_dry_run value options.

add_email_handler [Os_handlers]

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

add_email_service [Os_services]

A POST service to add an email to a user.

add_email_to_user [Os_db.​User]

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

add_icon [Os_fcm_notif.​Notification.​Android]

add_icon icon notification indicates notification icon.

add_image [Os_fcm_notif.​Data.​PhoneGap]

Add an image to the push notification in the notification area

add_info [Os_fcm_notif.​Data.​PhoneGap]

Add content-available: 1 also

add_led_color [Os_fcm_notif.​Data.​PhoneGap]

Change the LED color when the notification is received.

add_message [Os_fcm_notif.​Data.​PhoneGap]

Add a message attribute to the notification

add_notification_id [Os_fcm_notif.​Data.​PhoneGap]

Add a notification ID.

add_picture [Os_fcm_notif.​Data.​PhoneGap]

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

add_preregister [Os_user]

add_preregister email adds an email into the preregister collections.

add_preregister [Os_db.​User]

add_preregister email preregisters email in the database.

add_priority [Os_fcm_notif.​Options]

add_priority priority options sets the priority of the message.

add_priority [Os_fcm_notif.​Data.​PhoneGap]
add_raw_json [Os_fcm_notif.​Data]

add_raw_json key content_json data

add_raw_json [Os_fcm_notif.​Notification]

add_raw_json key content_json notification

add_raw_string [Os_fcm_notif.​Data]

add_raw_string key content data

add_raw_string [Os_fcm_notif.​Notification]

add_raw_string key content notification

add_restricted_package_name [Os_fcm_notif.​Options]

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 [Os_fcm_notif.​Notification]

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

add_soundname [Os_fcm_notif.​Data.​PhoneGap]

Add a soundame when the mobile receives the notification

add_style [Os_fcm_notif.​Data.​PhoneGap]
add_summary_text [Os_fcm_notif.​Data.​PhoneGap]

Add a summary text.

add_tag [Os_fcm_notif.​Notification.​Android]

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

add_time_to_live [Os_fcm_notif.​Options]

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_title [Os_fcm_notif.​Data.​PhoneGap]

Add a title attribute to the notification

add_title [Os_fcm_notif.​Notification]

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

add_to [Os_fcm_notif.​Options]

add_to to options specifies the recipient of a message.

add_user_in_group [Os_group]

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

add_user_in_group [Os_db.​Groups]

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

add_vibration_pattern [Os_fcm_notif.​Data.​PhoneGap]

Add a vibration pattern

add_visibility [Os_fcm_notif.​Data.​PhoneGap]

Add the visibility payload

all [Os_user]

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

all [Os_group]

all () returns all the groups of the database.

all [Os_db.​Groups]

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

all [Os_db.​User]

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

available [Os_db.​Email]

available email returns true if email is not already used.

avatar [Os_user_view]

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 [Os_user]

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

avatar_uri_of_avatar [Os_user]

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 [Os_user]

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.


B
block [Os_tips]

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

bubble [Os_tips]

Display tips in pages, as a speech bubble.


C
cache [Os_user_proxy]

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

canonical_ids_of_t [Os_fcm_notif.​Response]

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

close [Os_icons.​ICSIG]
confirm_code_extra [Os_connect_phone]

Confirm validation code and add extra phone to account.

confirm_code_extra_handler [Os_handlers]

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

confirm_code_extra_service [Os_services]

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

confirm_code_recovery [Os_connect_phone]

Confirm validation code and recover account.

confirm_code_recovery_handler [Os_handlers]

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

confirm_code_recovery_service [Os_services]

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

confirm_code_remind_service [Os_services]

Temporary alternate name for confirm_code_recovery_handler to facilite the transition.

confirm_code_signup [Os_connect_phone]

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

confirm_code_signup_handler [Os_handlers]

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_code_signup_service [Os_services]

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

connect [Os_session]

Open a session for a user by setting a session group for the browser which initiated the current request.

connect [Os_connect_phone]
connect_form [Os_user_view]

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 [Os_handlers]

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.

connect_service [Os_services]

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

connected_fun [Os_session.​Opt]

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.

connected_fun [Os_session]

Wrapper for service handlers that fetches automatically connection information.

connected_page [Os_page.​Make.​Opt]

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

connected_page [Os_page.​Make]

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

connected_rpc [Os_session.​Opt]

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.

connected_rpc [Os_session]

Wrapper for server functions (see Os_session.​connected_fun).

connected_user_box [Os_user_view]

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

connected_wrapper [Os_session]

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

connection_box [Os_user_view]

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

connection_pool [Os_db]

Direct access to the connection pool

content [Os_page]

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

create [Os_user]

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

create [Os_group]

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

create [Os_fcm_notif.​Options]

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

create [Os_fcm_notif.​Data.​PhoneGap.​Action]

create icon title callback foreground

create [Os_db.​Groups]

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

create [Os_db.​User]

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

crop_image [Os_uploader]

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 [Os_page.​PAGE]

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

css_class [Os_platform]

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


D
default_connected_error_page [Os_page.​PAGE]

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

default_connected_predicate [Os_page.​PAGE]

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

default_error_page [Os_page.​PAGE]

default_error_page get_param post_param exn is the default error page.

default_predicate [Os_page.​PAGE]

default_predicate get_param post_param is the default predicate.

delete [Os_db.​Phone]

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

desc_of_group [Os_group]

desc_of_group group returns the group description.

disconnect [Os_session]

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

disconnect_button [Os_user_view]

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

disconnect_handler [Os_handlers]

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

disconnect_link [Os_user_view]
disconnect_service [Os_services]

A POST service to disconnect the current user.


E
email_of_user [Os_user]

email_of_user user returns the main email of user user.

email_of_userid [Os_user]

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

email_of_userid [Os_db.​User]

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

email_pattern [Os_email]

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

email_regexp [Os_lib]
emails_of_user [Os_user]

emails_of_user user returns the emails of the user user.

emails_of_userid [Os_user]

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

emails_of_userid [Os_db.​User]

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

emails_of_userid_with_status [Os_db.​User]

Like emails_of_userid, but also returns validation status.

empty [Os_fcm_notif.​Data]

empty () creates an empty data value.

empty [Os_fcm_notif.​Notification]

empty () creates an empty notification

equal_key [Os_notif.​ARG]
exists [Os_db.​Phone]

Does the number exist in the database?


F
failure_of_t [Os_fcm_notif.​Response]

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

firstname_of_user [Os_user]

firstname_of_user user returns the first name of the user user

forgot_password_form [Os_user_view]

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

forgot_password_handler [Os_handlers]

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

forgot_password_service [Os_services]

A POST service when the user forgot his password.

full_transaction_block [Os_db]

full_transaction_block f executes function f within a database transaction.

fullname_of_user [Os_user]

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


G
generic_email_form [Os_user_view]

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

get [Os_request_cache.​Cache_sig]

Get the value corresponding to the given key.

get_actionlinkkey_info [Os_user]

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 [Os_db.​User]

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

get_current_user [Os_current_user.​Opt]

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

get_current_user [Os_current_user]

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

get_current_userid [Os_current_user.​Opt]

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

get_current_userid [Os_current_user]

get_current_userid () returns the ID of the current user.

get_data [Os_user_proxy]

get_data userid returns the user which has ID userid.

get_data_from_cache [Os_user_proxy]

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

get_data_from_db [Os_user_proxy]

get_data_from_db myid_o userid returns the user which has ID userid.

get_data_from_db_for_client [Os_user_proxy]

get_data_from_db_for_client myid_o userid returns the user which has ID userid.

get_data_rpc [Os_user_proxy]

get_data_rpc is a RPC to <<a_api subproject="server" | module Os_user_proxy.get_data_rpc'>>

get_data_rpc' [Os_user_proxy]

get_data_rpc' userid returns the user which has ID userid.

get_image_height [Os_uploader]

Return the height of the given image.

get_image_width [Os_uploader]

Return the width of the given image.

get_language [Os_user]

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

get_language [Os_db.​User]

get_language userid returns the language of the user with ID userid

get_list [Os_db.​Phone]

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

get_mailer [Os_email]

get_mailer () returns the name of mailer program.

get_users [Os_user]

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

get_users [Os_db.​User]

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

group_of_name [Os_group]

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

group_of_name [Os_db.​Groups]

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


H
has [Os_request_cache.​Cache_sig]

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

home_button [Os_user_view]

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


I
id_of_group [Os_group]

id_of_group group returns the group ID.

in_group [Os_group]

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

in_group [Os_db.​Groups]

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

information_form [Os_user_view]

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

init [Os_db]

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.

is_complete [Os_user]

is_complete user returns true if the first name or the last name of Os_types.user has not been completed yet.

is_email_validated [Os_user]

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

is_email_validated [Os_db.​User]

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

is_email_validated [Os_current_user]

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

is_main_email [Os_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 [Os_db.​User]

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

is_main_email [Os_current_user]

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

is_preregistered [Os_user]

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

is_preregistered [Os_db.​User]

is_preregistered email returns true if email is already registered.

is_registered [Os_user]

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

is_registered [Os_db.​User]

is_registered email returns true if the email is already registered.

is_valid [Os_email]

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


J
js [Os_page.​PAGE]

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


L
language_of_user [Os_user]

language_of_user user returns the language of the user user

lastname_of_user [Os_user]

lastname_of_user user returns the last name of the user user

local_css [Os_page.​PAGE]

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

local_from_calendar [Os_date]

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

local_js [Os_page.​PAGE]

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

local_to_calendar [Os_date]

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

lwt_bind_input_enter [Os_lib]

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

lwt_bound_input_enter [Os_lib]

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


M
main_service [Os_services]

The main service.

make_page [Os_page.​Make]

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

max_identity_per_resource [Os_notif.​ARG]
max_resource [Os_notif.​ARG]
memoizator [Os_lib]

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

message_id_of_success [Os_fcm_notif.​Response.​Results]

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

msg [Os_msg]

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

multicast_id_of_t [Os_fcm_notif.​Response]

multicast_id_of_t response returns the unique ID identifying the multicast message.


N
name_of_group [Os_group]

name_of_group group returns the group name.

notify [Os_notif.​S]
now [Os_date]

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


O
of_almost [Os_lib.​Email_or_phone]
of_string [Os_lib.​Email_or_phone.​Almost]
of_string [Os_lib.​Email_or_phone]
on_connected_request [Os_session]

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

on_denied_request [Os_session]

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

on_open_session [Os_session]

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

on_post_close_session [Os_session]

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

on_pre_close_session [Os_session]

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

on_request [Os_session]

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

on_start_connected_process [Os_session]

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

on_start_process [Os_session]

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

on_unconnected_request [Os_session]

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

other_head [Os_page.​PAGE]

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


P
page [Os_page.​Make]

Default wrapper for service handler generating pages.

password_form [Os_user_view]

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 [Os_user]

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

phone_regexp [Os_lib]
prepare [Os_notif.​ARG]
preregister_form [Os_user_view]

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 [Os_handlers]

preregister_handler () email preregisters the email email.

preregister_service [Os_services]

A POST service to preregister a user.

pwd_crypt_ref [Os_db]

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.


R
record_image [Os_uploader]

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

register_settings_service [Os_services]

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_success [Os_fcm_notif.​Response.​Results]

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 [Os_user]

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

remove_email_from_user [Os_db.​User]

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

remove_email_from_user [Os_current_user]

remove_email_from_user email removes the email email of the current user.

remove_preregister [Os_user]

remove_preregister email removes an email from the preregister collections.

remove_preregister [Os_db.​User]

remove_preregister email removes email from the database.

remove_user_in_group [Os_group]

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

remove_user_in_group [Os_db.​Groups]

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

request_code [Os_connect_phone]

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

request_recovery_code [Os_connect_phone]

Send a validation code for recovering an existing address.

reset [Os_request_cache.​Cache_sig]

Remove a value for the given key.

reset_tips [Os_tips]

Call this function to reset tips for current user.

reset_tips_link [Os_user_view]

Link to start to see the help from the beginning.

reset_tips_service [Os_tips]

A non-attached service that will reset tips.

resize_image [Os_uploader]

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

results_of_t [Os_fcm_notif.​Response]

results_of_t response returns the status of the messages processed.


S
send [Os_fcm_notif]

send server_key notification options

send [Os_email]

Send an e-mail to to_addrs from from_addr.

set [Os_request_cache.​Cache_sig]

Set the corresponding value for a key.

set_email_validated [Os_db.​User]

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

set_from_addr [Os_email]

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 [Os_email]

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 [Os_handlers]

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.

set_password_service [Os_services]

A POST service to update the password.

set_personal_data_handler [Os_handlers]

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

set_personal_data_service [Os_services]

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

set_pwd_crypt_fun [Os_user]

By default, passwords are encrypted using Bcrypt.

set_send [Os_email]

Customize email sending function.

set_send_sms_handler [Os_connect_phone]

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

set_tip_seen [Os_tips]

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

sign_up_form [Os_user_view]

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

sign_up_handler [Os_handlers]

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

sign_up_service [Os_services]

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

signout [Os_icons.​ICSIG]
smart_date [Os_date]

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 [Os_date]

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 [Os_date]

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

smart_interval [Os_date]

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 [Os_date]

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_filter [Os_lib]
string_of_error [Os_fcm_notif.​Response.​Results]

string_of_error error returns a string representation of the error error.

string_of_stream [Os_lib.​Http]

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

string_of_t [Os_platform]
string_repeat [Os_lib]
success_of_t [Os_fcm_notif.​Response]

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


T
t_of_string [Os_platform]
title [Os_page.​PAGE]

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

to_json [Os_fcm_notif.​Data.​PhoneGap.​Action]
to_json [Os_fcm_notif.​Notification]
to_list [Os_fcm_notif.​Options]

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

to_list [Os_fcm_notif.​Data]

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

to_local [Os_date]

Convert any type of calendar to a local calendar.

to_local_date [Os_date]

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

to_local_time [Os_date]

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

to_string [Os_lib.​Email_or_phone.​Almost]
to_string [Os_lib.​Email_or_phone]
to_utc [Os_date]

Convert a local calendar to a UTC calendar


U
unknown_timezone [Os_date]

unknown_timezone () returns true if the timezone is unknown.

unlisten_user [Os_notif.​S]

Make a user stop listening on data key.

update [Os_user]

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

update [Os_db.​User]

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

update' [Os_user]

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

update_avatar [Os_user]

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

update_avatar [Os_db.​User]

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

update_language [Os_user]

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

update_language [Os_db.​User]

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

update_language [Os_current_user]

update_language language updates the language of the current user.

update_language_service [Os_services]

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

update_main_email [Os_user]

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

update_main_email [Os_db.​User]

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

update_main_email [Os_current_user]

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

update_password [Os_user]

update_password ~userid ~password updates the password only.

update_password [Os_db.​User]

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

upload_pic_link [Os_user_view]

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

user [Os_icons.​ICSIG]
user_already_exists [Os_user]

Reference used to remember if the user already exists.

user_already_preregistered [Os_user]

Reference used to remeber if the user is already preregistered.

user_box [Os_user_view]

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

user_does_not_exist [Os_user]

Reference used to remember if the user exists.

user_indep_process_scope [Os_session]
user_indep_session_scope [Os_session]
user_indep_state_hierarchy [Os_session]

Scopes that are independant from user connection.

user_of_userid [Os_user]

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

user_of_userid [Os_db.​User]

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 [Os_date]

user_tz () returns current user's timezone.

userid [Os_db.​Phone]

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

userid_of_email [Os_user]

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

userid_of_email [Os_db.​User]

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

userid_of_user [Os_user]

userid_of_user user returns the userid of the user user.

username [Os_user_view]

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.


V
verify_password [Os_user]

verify_password email password verifies if email and password correspond.

verify_password [Os_db.​User]

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

verify_password_phone [Os_db.​User]

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


W
without_transaction [Os_db]

without_transaction f executes function f outside a database transaction.

wrong_password [Os_user]

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

wrong_pdata [Os_msg]

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


Y
y [Os_lib.​Email_or_phone.​Almost]
y [Os_lib.​Email_or_phone]