npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@capacitor-community/intercom

v6.0.2

Published

Enable Intercom features for Capacitor apps

Downloads

59,086

Readme

Sponsors

Maintainers

| Maintainer | GitHub | Social | | ------------ | --------------------------------------- | ----------------------------------------- | | Stewan Silva | stewones | @stewones |

Installation

Using npm:

npm install @capacitor-community/intercom

Using yarn:

yarn add @capacitor-community/intercom

Sync native files:

npx cap sync

Usage

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

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

// Register an indetified user
Intercom.registerIdentifiedUser({ userId: 123456 });
Intercom.registerIdentifiedUser({ email: '[email protected]' });
Intercom.registerIdentifiedUser({ userId: 123456, email: '[email protected]' });

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

iOS setup

  • 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": {
   "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 @capacitor-community/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

loadWithKeys(...)

loadWithKeys(options: { appId?: string; apiKeyIOS?: string; apiKeyAndroid?: string; }) => any

| Param | Type | | ------------- | ---------------------------------------------------------------------------- | | options | { appId?: string; apiKeyIOS?: string; apiKeyAndroid?: string; } |

Returns: any


registerIdentifiedUser(...)

registerIdentifiedUser(options: { userId?: string; email?: string; }) => any

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

Returns: any


registerUnidentifiedUser()

registerUnidentifiedUser() => any

Returns: any


updateUser(...)

updateUser(options: IntercomUserUpdateOptions) => any

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

Returns: any


logout()

logout() => any

Returns: any


logEvent(...)

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

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

Returns: any


displayMessenger()

displayMessenger() => any

Returns: any


displayMessageComposer(...)

displayMessageComposer(options: { message: string; }) => any

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

Returns: any


displayHelpCenter()

displayHelpCenter() => any

Returns: any


hideMessenger()

hideMessenger() => any

Returns: any


displayLauncher()

displayLauncher() => any

Returns: any


hideLauncher()

hideLauncher() => any

Returns: any


displayInAppMessages()

displayInAppMessages() => any

Returns: any


hideInAppMessages()

hideInAppMessages() => any

Returns: any


displayCarousel(...)

displayCarousel(options: { carouselId: string; }) => any

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

Returns: any


setUserHash(...)

setUserHash(options: { hmac: string; }) => any

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

Returns: any


setBottomPadding(...)

setBottomPadding(options: { value: string; }) => any

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

Returns: any


sendPushTokenToIntercom(...)

sendPushTokenToIntercom(options: { value: string; }) => any

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

Returns: any


receivePush(...)

receivePush(notification: IntercomPushNotificationData) => any

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

Returns: any


displayArticle(...)

displayArticle(options: { articleId: string; }) => any

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

Returns: any


addListener(...)

addListener(eventName: 'windowDidShow', listenerFunc: () => void) => any

| Param | Type | | ------------------ | ---------------------------- | | eventName | "windowDidShow" | | listenerFunc | () => void |

Returns: any


addListener(...)

addListener(eventName: 'windowDidHide', listenerFunc: () => void) => any

| Param | Type | | ------------------ | ---------------------------- | | eventName | "windowDidHide" | | listenerFunc | () => void |

Returns: any


removeAllListeners()

removeAllListeners() => any

Returns: any


Interfaces

IntercomUserUpdateOptions

| Prop | Type | | ---------------------- | ------------------------------------ | | userId | string | | email | string | | name | string | | phone | string | | languageOverride | string | | customAttributes | { [key: string]: any; } |

IntercomPushNotificationData

| Prop | Type | | ------------------------------- | ------------------- | | conversation_id | string | | message | string | | body | string | | author_name | string | | image_url | string | | app_name | string | | receiver | string | | conversation_part_type | string | | intercom_push_type | string | | uri | string | | push_only_conversation_id | string | | instance_id | string | | title | string | | priority | number |

PluginListenerHandle

| Prop | Type | | ------------ | ------------------------- | | remove | () => any |

Notice 🚀

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.

Breaking changes from Capacitor v2 to v3

  • UserUpdateOptions option type becomes IntercomUserUpdateOptions
  • IntercomPlugin configuration key becomes Intercom
  • android-apiKey config key becomes androidApiKey
  • android-appId config key becomes androidAppId
  • ios-apiKey config key becomes iosApiKey
  • ios-appId config key becomes iosAppId
  • Switch from CAPBridge to ApplicationDelegateProxy in application events
  • remove the whole onCreate initialization from your app's MainActivity.java
 public class MainActivity extends BridgeActivity {
-    @Override
-    public void onCreate(Bundle savedInstanceState) {
-        super.onCreate(savedInstanceState);
-
-        // Initializes the Bridge
-        this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
-            // Additional plugins you've installed go here
-            add(IntercomPlugin.class);
-        }});
-    }
 }

License

MIT

Example

  • https://github.com/capacitor-community/intercom/blob/master/example

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!