Wednesday, September 11, 2013

PhoneGap Android AndroidPreferences Plugin

Update: Changed to be compatible with PhoneGap 3 and higher.

Here is a small blog about how to store preferences of your PhoneGap app on the native side, using SharedPreferences.

What does it do


This plugin can be very handy if you are having multiple services that run native code, but need to use shared preferences. You can set, get and compare values. No further coding in Java is required, as it works out of the box. Every value is stored as a string (so no booleans, integers or any other type than strings).

PhoneGap plugin


The above is done by creating a phonegap plugin. Create the class (.java file) in the package "org.apache.cordova.plugins"

AndroidPreferences.java



Create the javascript file "androidpreferences.js" and include it in your HTML AFTER the include of the phonegap/cordova javascript files.

androidpreferences.js



Add the following line to the "config.xml" file in your res folder of your Android project.

And from that point you can call the plugin in your application by using the statement below.

In your app (javascript)



The  script above can be adjusted to your liking of course.

If you have questions please let me know.

Copyright (c) 2015 Joram Teusink

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.