Home

Awesome

ocaml-cordova-plugin-fcm

LGPL-v3 licensed Build Status

Binding to cordova-plugin-fcm

What does cordova-plugin-fcm do?

Extremely easy plug&play push notification plugin for Cordova applications with Google Firebase FCM.

Source: cordova-plugin-fcm

How to install and compile your project by using this plugin?

Don't forget to switch to a compiler >= 4.03.0.

opam switch 4.03.0

For the dev version, you can use OPAM by pinning the repository with

opam pin add cordova-plugin-fcm https://github.com/dannywillems/ocaml-cordova-plugin-fcm.git

To compile your project, use

ocamlfind ocamlc -c -o [output_file] -package gen_js_api -package cordova-plugin-fcm [...] -linkpkg [other arguments]

Don't forget to install cordova-plugin-fcm with

cordova plugin add cordova-plugin-fcm

How to use?

You can find the documentation here which is the GitHub HTML preview of the doc directory. The documentation is generated thanks to ocamldoc with the command

make doc-html

which is

mkdir -p doc
ocamlfind ocamldoc -html -package gen_js_api -d doc cordova_push.mli

You have also the plugin documentation and source code here

About certificates.

Firebase allows you to send push notifications to Android and iOS devices at the same time, with the same interface. For that, you need to configure Firebase. All instructions are available on the Firebase documentation and in the Cordova plugin documentation.