Skip to content

Commit aadf30d

Browse files
committed
Add Expo installation and configuration instructions for react-native-callkeep
1 parent db693d5 commit aadf30d

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,46 @@ You can alternatively just call `setSettings()` with the same option as `setup()
165165
166166
To use this library with Expo, you will need to create a development build. Expo Go does not support custom native modules. For information on how to create and run a development build, visit: [Create a development build - Expo Documentation](https://docs.expo.dev/develop/development-builds/create-a-build/). You can use and test this library with a development build installed on your physical device (iOS and Android).
167167
168+
Once you have created your development build, follow these steps to install and configure `react-native-callkeep` with Expo:
169+
170+
1. Install the required packages:
171+
```sh
172+
npx expo install react-native-callkeep
173+
npx expo install @config-plugins/react-native-callkeep
174+
```
175+
176+
2. Update your `app.json` or `app.config.js|ts` to include the necessary permissions and plugins:
177+
178+
```json
179+
{
180+
"expo": {
181+
// ... other config ...
182+
"android": {
183+
"permissions": [
184+
// The following permissions should be automatically added by
185+
// @config-plugins/react-native-callkeep
186+
// when you create a development build (using `npx expo prebuild` or `eas build`).
187+
// If they are not added, you can manually include them as shown below.
188+
"android.permission.BIND_TELECOM_CONNECTION_SERVICE",
189+
"android.permission.FOREGROUND_SERVICE",
190+
"android.permission.READ_PHONE_STATE",
191+
"android.permission.CALL_PHONE",
192+
193+
// You may also need these additional permissions.
194+
// For more details, see:
195+
// https://github.com/react-native-webrtc/react-native-callkeep/blob/db693d5b6a0a3c38b5d645fd53fc37801d016742/android/src/main/java/io/wazo/callkeep/RNCallKeepModule.java#L115
196+
"android.permission.READ_PHONE_NUMBERS",
197+
"android.permission.RECORD_AUDIO"
198+
]
199+
},
200+
"plugins": [
201+
// ... other plugins ...
202+
"@config-plugins/react-native-callkeep"
203+
]
204+
}
205+
}
206+
```
207+
168208
# Constants
169209

170210
To make passing the right integer into methods easier, there are constants that are exported from the module.

0 commit comments

Comments
 (0)