@capacitor-community/intercom
Capacitor community plugin for enabling Intercom capabilities
Maintainer | GitHub | Social |
---|---|---|
Stewan Silva | stewwan | @StewanSilva |
We're starting fresh under an official org. If you were using the previous npm package capacitor-intercom
, please update your package.json to @capacitor-community/intercom
. Check out changelog for more info.
Using npm:
npm install @capacitor-community/intercom
Using yarn:
yarn add @capacitor-community/intercom
Sync native files:
npx cap sync
- registerIdentifiedUser
- registerUnidentifiedUser
- updateUser
- logout
- logEvent
- displayMessenger
- displayMessageComposer
- displayHelpCenter
- hideMessenger
- displayLauncher
- hideLauncher
- displayInAppMessages
- hideInAppMessages
- setUserHash
- setBottomPadding
import { Intercom } from "@capacitor-community/intercom";
const intercom = new Intercom();
import { Plugins } from "@capacitor/core";
const { PushNotifications } = Plugins;
//
// Register for push notifications from Intercom
PushNotifications.register()
//
// Register an indetified user
intercom
.registerIdentifiedUser({ userId: 123456 }) // or email or both
//
// Register a log event
intercom
.logEvent({ name: "my-event", data: { pi: 3.14 } })
//
// Display the message composer
intercom
.displayMessageComposer({ message: "Hello there!" } })
//
// Identity Verification
// https://developers.intercom.com/installing-intercom/docs/ios-identity-verification
intercom
.setUserHash({ hmac: "xyz" } })
ionic start my-cap-app --capacitor
cd my-cap-app
npm install โ-save @capacitor-community/intercom
mkdir www && touch www/index.html
npx cap add ios
- add intercom keys to capacitor's configuration file
{
โฆ
"plugins": {
"IntercomPlugin": {
"ios-apiKey": "ios_sdk-xxx",
"ios-appId": "yyy"
}
}
โฆ
}
npx cap open ios
- sign your app at xcode (general tab)
Tip: every time you change a native code you may need to clean up the cache (Product > Clean build folder) and then run the app again.
ionic start my-cap-app --capacitor
cd my-cap-app
npm install โ-save @capacitor-community/intercom
mkdir www && touch www/index.html
npx cap add android
- add intercom keys to capacitor's configuration file
{
โฆ
"plugins": {
"IntercomPlugin": {
"android-apiKey": "android_sdk-xxx",
"android-appId": "yyy"
}
}
โฆ
}
npx cap open android
[extra step]
in android case we need to tell Capacitor to initialise the plugin:
on your
MainActivity.java
file addimport com.getcapacitor.community.intercom.IntercomPlugin;
and then inside the init callbackadd(IntercomPlugin.class);
Now you should be set to go. Try to run your client using ionic cap run android --livereload
.
Tip: every time you change a native code you may need to clean up the cache (Build > Clean Project | Build > Rebuild Project) and then run the app again.
MIT
Thanks goes to these wonderful people (emoji key):
Stew ๐ป ๐ |
David Seek ๐ป |
Roman Nikitin ๐ป |
Anne Tomassoni ๐ป ๐ |
Maciej Modzelewski ๐ป |
Oleg Yuzvik ๐ง |
This project follows the all-contributors specification. Contributions of any kind welcome!