Skip to content

readme/doc: fix typo and remove duplicated endAllCalls method sections #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2020
Merged

readme/doc: fix typo and remove duplicated endAllCalls method sections #168

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
744e6c8
readme: fix typo
zxcpoiu Mar 11, 2020
fa35ab2
readme: make endCall api usage more clearer
zxcpoiu Mar 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -229,7 +230,7 @@ RNCallKeep.endCall(uuid);

### endAllCalls

End all ongoing connections.
End all ongoing calls.

```js
RNCallKeep.endAllCalls();
Expand All @@ -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);
Expand Down Expand Up @@ -295,14 +298,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).
Expand Down Expand Up @@ -463,7 +458,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
Expand Down