From 744e6c8b79a53772d375aa82ecf514d7acec5dd6 Mon Sep 17 00:00:00 2001 From: zxcpoiu Date: Wed, 11 Mar 2020 16:30:02 +0800 Subject: [PATCH 1/2] readme: fix typo fix typo and remove duplicated `endAllCalls` method sections --- README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8117b460..1ebcb67f 100644 --- a/README.md +++ b/README.md @@ -229,7 +229,7 @@ RNCallKeep.endCall(uuid); ### endAllCalls -End all ongoing connections. +End all ongoing calls. ```js RNCallKeep.endAllCalls(); @@ -295,14 +295,6 @@ RNCallKeep.setOnHold(uuid, true) - uuid of the current call. - `hold`: boolean -### endAllCalls - -End all calls that have been started on the device. - -```js -RNCallKeep.endAllCalls(); -``` - ### checkIfBusy 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 +455,7 @@ RNCallKeep.addEventListener('didDisplayIncomingCall', ({ error, callUUID, handle - `fromPushKit` (string) - `1` (call triggered from PushKit) - `0` (call not triggered from PushKit) -- `didDisplayIncomingCall` (object) +- `payload` (object) - VOIP push payload. ### - didPerformSetMutedCallAction From fa35ab22bfa9e4f320d9de13900929bc95cab789 Mon Sep 17 00:00:00 2001 From: zxcpoiu Date: Wed, 11 Mar 2020 19:25:28 +0800 Subject: [PATCH 2/2] readme: make endCall api usage more clearer --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1ebcb67f..7ab81672 100644 --- a/README.md +++ b/README.md @@ -218,7 +218,8 @@ RNCallKeep.updateDisplay(uuid, displayName, handle) ### endCall -When you finish an incoming/outgoing call. +When finish an incoming/outgoing call. +(When user actively chooses to end the call from your app's UI.) ```js RNCallKeep.endCall(uuid); @@ -248,7 +249,9 @@ RNCallKeep.rejectCall(uuid); ### reportEndCallWithUUID -Report that the call ended without the user initiating +Report that the call ended without the user initiating. +(Not ended by user, is usually due to the following reasons) + ```js RNCallKeep.reportEndCallWithUUID(uuid, reason);