This is server API (go to client)

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

Index of modules


A
Action [Os_fcm_notif.​Data.​PhoneGap]
Action_link_key [Os_types]
Almost [Os_lib.​Email_or_phone]
Android [Os_fcm_notif.​Notification]

D
D [Os_icons]
Data [Os_fcm_notif]
Default_config [Os_page]

A default configuration for pages.


E
Email [Os_db]

This module is used for low-level email management with database.

Email_or_phone [Os_lib]

Parse strings that can be e-mails or phones.


F
F [Os_icons]

G
Group [Os_types]
Groups [Os_db]

This module is low-level and used to manage groups of user.


H
Http [Os_lib]

This module contains functions about HTTP request.


I
Ios [Os_fcm_notif.​Notification]

M
Make [Os_request_cache]

Functor which creates a module Os_request_cache.​Cache_sig.

Make [Os_page]
Make [Os_notif]

see Eliom_notif.Make

Make_Simple [Os_notif]

Use this functor in case messages are to be delivered only to clients connected to the current server, as is always the case in a single-server set-up.


N
Notification [Os_fcm_notif]

This module provides an interface to create the JSON for the notification key.


O
Opt [Os_session]
Opt [Os_page.​Make]
Opt [Os_current_user]

Instead of exception, the module Opt returns an option.

Options [Os_fcm_notif]
Os_comet

This module provides function to monitor communications between the server clients.

Os_connect_phone

To be used for signalling errors with SMS transmission

Os_current_user

This module provides functions and types to manage the current user.

Os_date

Time zone and date management for Web applications.

Os_db

This module defines low level functions for database requests.

Os_email

Basic module for sending e-mail messages to users, using some local sendmail program.

Os_fcm_notif

Send push notifications to Android and iOS mobile devices.

Os_group

Groups of users.

Os_handlers

This module contains pre-defined handlers for connect, disconnect, sign up, add a new email, etc.

Os_icons

The icons used internally by Ocsigen Start's library.

Os_lib

This module aims to provide common utilities functions.

Os_msg

This module provides functions to display messages (client-side or server-side).

Os_notif

Server to client notifications.

Os_page

Functor defining wrappers for services handlers returning pages.

Os_platform

About device platform.

Os_request_cache

Caching request data to avoid doing the same computation several times during the same request.

Os_services

This module provides pre-defined services for connect, disconnect, sign up, add a new email, etc.

Os_session

Connection and disconnection of users, restrict access to services or server functions, define actions to be executed at some points of the session.

Os_tips

Tips for new users and new features.

Os_types

Data types

Os_uploader

This module defines functions to manipulate images to be uploaded.

Os_user

This module provides functions and types about users.

Os_user_proxy

This module implements a cache of user using <<a_api project="eliom" | module Eliom_cscache>> which allows to keep synchronized the cache between the client and the server.

Os_user_view

This module defines functions to create password forms, connection forms, settings buttons and other common contents arising in applications.


P
PGOCaml [Os_db]

Lwt version of PGOCaml

Phone [Os_db]

Manage user phone numbers

PhoneGap [Os_fcm_notif.​Data]

The Cordova plugin phonegap-plugin-push interprets some payloads defined in the data key.

Priority [Os_fcm_notif.​Options]

This modules defines a type for priorities for the notifications.

Priority [Os_fcm_notif.​Data.​PhoneGap]

R
Register [Os_icons]
Response [Os_fcm_notif]
Results [Os_fcm_notif.​Response]

The type representing a FCM response


S
Style [Os_fcm_notif.​Data.​PhoneGap]

U
User [Os_types]
User [Os_db]

This module is used for low-level user management with database.


V
Visibility [Os_fcm_notif.​Data.​PhoneGap]