@houseninja/capacitor-intercom

v4.3.0

Published

2 years ago

Enable Intercom features for Capacitor apps

Downloads

0High
0Medium
0Low

mileszim

capacitor plugin native

Maintainers

| Maintainer | GitHub | Social | | --------------- | --------------------------------------------------- | ----------------------------------------- | | Miles Zimmerman | mileszim | @mileszim | | House Ninja | houseninjadojo | |

Installation

Using npm:

npm install @houseninja/capacitor-intercom

Using yarn:

yarn add @houseninjad/capacitor-intercom

Sync native files:

npx cap sync

Usage

Web Only

For web, you must run boot({ appId: <app-id> }) to initialize.

import { Intercom } from '@houseninja/capacitor-intercom';

Intercom.boot({
  appId: '12345',
  email: '[email protected]', // you can set user details on boot:
  userId: '1234',            // see https://developers.intercom.com/installing-intercom/docs/intercom-javascript#intercomboot-intercomsettings
});

Intercom.registerIdentifiedUser({
  email: '[email protected]', // you can also set user details like the mobile SDKs
  userId: '1234',
});

// show intercom
Intercom.show();

Web, iOS, Android

import { Intercom } from '@houseninja/capacitor-intercom';
import { PushNotifications } from '@capacitor/push-notifications';

// Register for push notifications from Intercom
await PushNotifications.register();

// Register an indetified user
await Intercom.registerIdentifiedUser({ userId: 123456 }); // or email or both

// Register a log event
await Intercom.logEvent({ name: 'my-event', data: { pi: 3.14 } });

// Display the message composer
await Intercom.displayMessageComposer({ message: 'Hello there!' });

// Identity Verification
// https://developers.intercom.com/installing-intercom/docs/ios-identity-verification
await Intercom.setUserHash({ hmac: 'xyz' });

// Get Unread Conversation Count
await Intercom.unreadConversationCount();

// Listen for unread conversation count to change
Intercom.addListener('onUnreadCountChange', ({ value }) => {
  console.log('conversation count is: ', value);
});

iOS setup

ionic start my-cap-app --capacitor
cd my-cap-app
npm install —-save @houseninja/capacitor-intercom
mkdir www && touch www/index.html
npx cap add ios
add intercom keys to capacitor's configuration file

{
 …
  "plugins": {
   "Intercom": {
      "iosApiKey": "ios_sdk-xxx",
      "iosAppId": "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.

Android setup

ionic start my-cap-app --capacitor
cd my-cap-app
npm install —-save @houseninja/capacitor-intercom
mkdir www && touch www/index.html
npx cap add android
add intercom keys to capacitor's configuration file

{
 …
  "plugins": {
   "Intercom": {
      "androidApiKey": "android_sdk-xxx",
      "androidAppId": "yyy"
    }
  }
…
}

npx cap open android

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.

API

boot(...)

boot(options: IntercomSettings) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------------------- | | options | IntercomSettings |

loginUser(...)

loginUser(options: { userId?: string; email?: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | { userId?: string; email?: string; } |

registerIdentifiedUser(...)

registerIdentifiedUser(options: { userId?: string; email?: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | { userId?: string; email?: string; } |

loginUnidentifiedUser()

loginUnidentifiedUser() => Promise<void>

registerUnidentifiedUser()

registerUnidentifiedUser() => Promise<void>

updateUser(...)

updateUser(options: IntercomUserUpdateOptions) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------------------------------------- | | options | IntercomUserUpdateOptions |

logout()

logout() => Promise<void>

logEvent(...)

logEvent(options: { name: string; data?: any; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------ | | options | { name: string; data?: any; } |

displayMessenger()

displayMessenger() => Promise<void>

show()

show() => Promise<void>

displayInbox()

displayInbox() => Promise<void>

displayMessageComposer(...)

displayMessageComposer(options: { message: string; }) => Promise<void>

| Param | Type | | ------------- | --------------------------------- | | options | { message: string; } |

displayHelpCenter()

displayHelpCenter() => Promise<void>

displayArticle(...)

displayArticle(options: { articleId: string; }) => Promise<void>

| Param | Type | | ------------- | ----------------------------------- | | options | { articleId: string; } |

displayCarousel(...)

displayCarousel(options: { carouselId: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------------ | | options | { carouselId: string; } |

displayLauncher()

displayLauncher() => Promise<void>

enableLauncher()

enableLauncher() => Promise<void>

displayInAppMessages()

displayInAppMessages() => Promise<void>

enableMessengerPopups()

enableMessengerPopups() => Promise<void>

hideMessenger()

hideMessenger() => Promise<void>

hide()

hide() => Promise<void>

hideLauncher()

hideLauncher() => Promise<void>

disableLauncher()

disableLauncher() => Promise<void>

hideInAppMessages()

hideInAppMessages() => Promise<void>

disableMessengerPopups()

disableMessengerPopups() => Promise<void>

setUserHash(...)

setUserHash(options: { hmac: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------ | | options | { hmac: string; } |

setBottomPadding(...)

setBottomPadding(options: { value: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

sendPushTokenToIntercom(...)

sendPushTokenToIntercom(options: { value: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

receivePush(...)

receivePush(notification: IntercomPushNotificationData) => Promise<void>

| Param | Type | | ------------------ | ------------------------------------------------------------------------------------- | | notification | IntercomPushNotificationData |

unreadConversationCount()

unreadConversationCount() => Promise<UnreadConversationCount>

Returns: Promise<UnreadConversationCount>

addListener('onUnreadCountChange', ...)

addListener(eventName: 'onUnreadCountChange', listenerFunc: UnreadCountChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ------------------------------------------------------------------------------- | | eventName | 'onUnreadCountChange' | | listenerFunc | UnreadCountChangeListener |