cordova-plugin-hipmob-android

The Hipmob Cordova plugin for Android provides Phonegap applications access to helpdesk, live chat and support CRM tools using the Hipmob platform. For more information visit https://www.hipmob.com.

It is compatible with Android 2.1 and higher, and works on versions of Cordova greater than 2.9.0.

Installation

Install the plugin using the Cordova command-line interface:

cordova plugin add https://github.com/hipmob/cordova-plugin-hipmob-android.git

On Windows, you may have issues with the install (we've observed Git errors when trying to do the fetch). If that's the case, you'll want to clone the repository and then do a local add: make sure you clone the plugin to a directory outside your app.

git clone https://github.com/hipmob/cordova-plugin-hipmob-android.git <directory location of plugin>
cd <root of application>
cordova plugin add <directory location of plugin>

Usage

To use the Hipmob library, you'll need to get a free account at https://www.hipmob.com/. Once you have an account, visit https://manage.hipmob.com/#apps to get your application ID. You can then open a support chat window from a button:

if( window.plugins && window.plugins.Hipmob ) {
    var hipmob_app_id = '<HIPMOB APPLICATION ID>';
    var Hipmob = window.plugins.Hipmob;

    Hipmob.openChat(hipmob_app_id, {
'title': 'Help',
'user': '<hipmob user id>',
'name': 'Femi',
'email': '[email protected]',
'context': 'shopping for shoes',
'location': 'At home'
});
} else {
  alert('Hipmob plugin not available/ready.');
}

To open a helpdesk search window, you can do:

if( window.plugins && window.plugins.Hipmob ) {
    var hipmob_app_id = '<HIPMOB APPLICATION ID>';
    var Hipmob = window.plugins.Hipmob;

    Hipmob.openHelpdeskSearch(hipmob_app_id, {
'title': 'Help',
'query': 'Android',
'user': '<hipmob user id>',
'name': 'Femi',
'email': '[email protected]',
'context': 'shopping for shoes',
'location': 'At home'
});
} else {
  alert('Hipmob plugin not available/ready.');
}

To open an instant help window, you can do:

if( window.plugins && window.plugins.Hipmob ) {
    var hipmob_app_id = '<HIPMOB APPLICATION ID>';
var helpdesk_article = '<helpdesk article ID>';
    var Hipmob = window.plugins.Hipmob;

    Hipmob.openHelpdeskArticle(hipmob_app_id, helpdesk_article, {
'title': 'Help',
'user': '<hipmob user id>',
'name': 'Femi',
'email': '[email protected]',
'context': 'shopping for shoes',
'location': 'At home'
});
} else {
  alert('Hipmob plugin not available/ready.');
}