Skip to content

Commit 62214b9

Browse files
committed
Added documentation for self managed
1 parent 81b82bb commit 62214b9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ RNCallKeep.setup(options).then(accepted => {});
9393
- `additionalPermissions`: [PermissionsAndroid] (optional)
9494
Any additional permissions you'd like your app to have at first launch. Can be used to simplify permission flows and avoid
9595
multiple popups to the user at different times.
96+
- `selfManaged`: boolean (optional)
97+
When set to true, call keep will configure itself to run as a self managed connection service. This is an advanced topic, and it's best to refer to [Googles Documentation](https://developer.android.com/guide/topics/connectivity/telecom/selfManaged) on the matter.
9698

9799
`setup` calls internally `registerPhoneAccount` and `registerEvents`.
98100

@@ -658,6 +660,27 @@ RNCallKeep.addEventListener('didLoadWithEvents', (events) => {
658660
- `data`: object
659661
Object with data passed together with specific event so it can be handled in the same way like original event, for example `({ callUUID })` for `answerCall` event if `name` is `RNCallKeepPerformAnswerCallAction`
660662

663+
### - showIncomingCallUi
664+
665+
Android only.
666+
667+
Only when CallKeep is setup to be in self managed mode. Signals that the app must show an incoming call UI. The implementor must either call `displayIncomingCall` from react native or native android code to make this event fire.
668+
669+
```js
670+
RNCallKeep.addEventListener('showIncomingCallUi', ({ handle, callUUID, name }) => {
671+
672+
});
673+
```
674+
675+
The following values will match those initially passed to `displayIncomingCall`
676+
677+
- `handle` (string)
678+
- Phone number of the incoming caller.
679+
- `callUUID` (string)
680+
- The UUID of the call.
681+
- `name` (string)
682+
- Caller Name.
683+
661684
### - checkReachability
662685

663686
On Android when the application is in background, after a certain delay the OS will close every connection with informing about it.

0 commit comments

Comments
 (0)