Skip to content

Commit d21c9c3

Browse files
authored
Merge pull request #168 from react-native-webrtc/zxcpoiu-patch-1
readme/doc: fix typo and remove duplicated `endAllCalls` method sections
2 parents 2b1442e + fa35ab2 commit d21c9c3

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,8 @@ RNCallKeep.updateDisplay(uuid, displayName, handle)
218218

219219
### endCall
220220

221-
When you finish an incoming/outgoing call.
221+
When finish an incoming/outgoing call.
222+
(When user actively chooses to end the call from your app's UI.)
222223

223224
```js
224225
RNCallKeep.endCall(uuid);
@@ -229,7 +230,7 @@ RNCallKeep.endCall(uuid);
229230

230231
### endAllCalls
231232

232-
End all ongoing connections.
233+
End all ongoing calls.
233234

234235
```js
235236
RNCallKeep.endAllCalls();
@@ -248,7 +249,9 @@ RNCallKeep.rejectCall(uuid);
248249

249250
### reportEndCallWithUUID
250251

251-
Report that the call ended without the user initiating
252+
Report that the call ended without the user initiating.
253+
(Not ended by user, is usually due to the following reasons)
254+
252255

253256
```js
254257
RNCallKeep.reportEndCallWithUUID(uuid, reason);
@@ -295,14 +298,6 @@ RNCallKeep.setOnHold(uuid, true)
295298
- uuid of the current call.
296299
- `hold`: boolean
297300

298-
### endAllCalls
299-
300-
End all calls that have been started on the device.
301-
302-
```js
303-
RNCallKeep.endAllCalls();
304-
```
305-
306301
### checkIfBusy
307302

308303
Checks if there are any active calls on the device and returns a promise with a boolean value (`true` if there're active calls, `false` otherwise).
@@ -463,7 +458,7 @@ RNCallKeep.addEventListener('didDisplayIncomingCall', ({ error, callUUID, handle
463458
- `fromPushKit` (string)
464459
- `1` (call triggered from PushKit)
465460
- `0` (call not triggered from PushKit)
466-
- `didDisplayIncomingCall` (object)
461+
- `payload` (object)
467462
- VOIP push payload.
468463

469464
### - didPerformSetMutedCallAction

0 commit comments

Comments
 (0)