https://github.com/mateioprea/react-native-intercom

React Native Intercom Module
https://github.com/mateioprea/react-native-intercom

android hacktoberfest intercom ios react-native react-native-intercom-native

Last synced: about 1 month ago
JSON representation

React Native Intercom Module

• Host: GitHub
• URL: https://github.com/mateioprea/react-native-intercom
• Owner: mateioprea
• License: mit
• Created: 2020-09-22T13:49:03.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-04-16T17:34:18.000Z (about 3 years ago)
• Last Synced: 2024-03-28T13:43:16.087Z (2 months ago)
• Topics: android, hacktoberfest, intercom, ios, react-native, react-native-intercom-native
• Language: Objective-C
• Homepage:
• Size: 17.3 MB
• Stars: 25
• Watchers: 4
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-react-native - react-native-intercom-native ★7 - native based Intercom implementation for React Native (Components / Integrations)
• awesome-react-native - react-native-intercom-native ★7 - native based Intercom implementation for React Native (Components / Integrations)
• awesome-react-native - react-native-intercom-native ★7 - native based Intercom implementation for React Native (Components / Integrations)

README

        


  React Native Intercom Native





  

  



Intercom implementation for react native

## Installation

### Automatic install

```sh

npm install react-native-intercom-native

```

```sh

npx intercom-link

```

If you don't want Intercom Push Notifications, you should run `npx intercom` along with the `--disable-notification-link` parameter.

### Manual Installation

```sh

npm install react-native-intercom-native

```

You should be set up!

## Usage

```js

import Intercom from "react-native-intercom-native";

Intercom.setApiKey(

	Platform.OS === 'android'

		? 'your_intercom_android_api_key'

		: 'your_intercom_ios_api_key',

	'your_app_id'

);

//TODO

```

## Documentation

Check the [available APIs](docs/API.md).

## Push Notifications

For configuring push notifications you should follow these steps:

### iOS

On iOS you should only follow steps 1, 2, 3 and 4 from Intercom documentation that's available [here](https://developers.intercom.com/installing-intercom/docs/ios-push-notifications).

This plugin already does the extra steps that are necessary to handle push notifications, so you should be good to go.

### Android

On android you should follow steps 1, 3 and 4 (yes, without step 2) from Intercom documentation that's available [here](https://developers.intercom.com/installing-intercom/docs/android-fcm-push-notifications).

After you generated the google-services.json file just place it in 'your_react_native_project_root/android/app/' folder. This is it. You're done.

## Hooks

//TODO

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT