Code Monkey home page Code Monkey logo

cordova-plugin-hipmob-android's Introduction

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.');
}

cordova-plugin-hipmob-android's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.