You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+52-25Lines changed: 52 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,55 @@
1
1
# react-native-twilio-programmable-voice
2
2
3
-
This is a React-Native wrapper for[Twilio Programmable Voice SDK](https://www.twilio.com/voice) which lets you make and receive calls from your React-Native App. This module is not affiliated with nor officially maintained by Twilio, and it is maintained by open source contributors.
3
+
This is a react-native wrapper around[Twilio Programmable Voice SDK](https://www.twilio.com/voice), which allows your react-native app to make and receive calls.
4
4
5
-
## Twilio Programmable Voice SDK
5
+
This module is not affiliated with nor officially maintained by Twilio. It is maintained by open source contributors working during their nights and weekends.
6
6
7
-
- Android 4.5.0 (bundled within the module)
8
-
- iOS 5.1.0 (specified by the app's own podfile)
7
+
Tested with:
9
8
10
-
## Breaking changes in v4.0.0
9
+
- react-native 0.62.2
10
+
- Android 11
11
+
- iOS 14
12
+
13
+
## Roadmap
14
+
15
+
### Project 1
16
+
17
+
The most updated branch is [feat/twilio-android-sdk-5](https://github.com/hoxfon/react-native-twilio-programmable-voice/tree/feat/twilio-android-sdk-5) which is aligned with:
18
+
19
+
- Android 5.0.2
20
+
- iOS 5.2.0
21
+
22
+
It contains breaking changes from `react-native-twilio-programmable-voice` v4, and it will be released as v5.
_If you want to contribute please consider helping on this project._
40
+
41
+
### Project 2
42
+
43
+
Allow Android to use the built in Android telephony service to make and receive calls.
44
+
45
+
## Stable release
46
+
47
+
### Twilio Programmable Voice SDK
48
+
49
+
- Android 4.5.0
50
+
- iOS 5.2.0
51
+
52
+
### Breaking changes in v4.0.0
11
53
12
54
The module implements [react-native autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) as many other native libraries > react-native 0.60.0, therefore it doesn't need to be linked manually.
13
55
@@ -53,14 +95,14 @@ iOS application can now receive the following events, that in v3 where only disp
53
95
- connectionIsReconnecting
54
96
- connectionDidReconnect
55
97
56
-
## Breaking changes in v3.0.0
98
+
###Breaking changes in v3.0.0
57
99
58
100
- initWitToken returns an object with a property `initialized` instead of `initilized`
59
101
- iOS event `connectionDidConnect` returns the same properties as Android
60
102
move property `to` => `call_to`
61
103
move property `from` => `call_from`
62
104
63
-
## Installation
105
+
###Installation
64
106
65
107
Before starting, we recommend you get familiar with [Twilio Programmable Voice SDK](https://www.twilio.com/docs/api/voice-sdk).
66
108
It's easier to integrate this module into your react-native app if you follow the Quick start tutorial from Twilio, because it makes very clear which setup steps are required.
@@ -92,23 +134,8 @@ After you have linked the library with `react-native link react-native-twilio-pr
92
134
check that `libRNTwilioVoice.a` is present under YOUR_TARGET > Build Phases > Link Binaries With Libraries. If it is not present you can add it using the + sign at the bottom of that list.
93
135
</details>
94
136
95
-
Edit your `Podfile` to include TwilioVoice framework
96
-
97
-
```ruby
98
-
source 'https://github.com/cocoapods/specs'
99
-
100
-
# min version for TwilioVoice to work
101
-
platform :ios, '10.0'
102
-
103
-
target <YOUR_TARGET>do
104
-
...
105
-
pod 'TwilioVoice', '~> 5.2.0'
106
-
...
107
-
end
108
-
```
109
-
110
137
```bash
111
-
cd ios/&& pod install
138
+
cd ios && pod install
112
139
```
113
140
114
141
#### CallKit
@@ -130,7 +157,7 @@ To pass caller's name to CallKit via Voip push notification add custom parameter
130
157
131
158
Twilio Programmable Voice for iOS utilizes Apple's VoIP Services and VoIP "Push Notifications" instead of FCM. You will need a VoIP Service Certificate from Apple to receive calls. Follow [the official Twilio instructions](https://github.com/twilio/voice-quickstart-ios#7-create-voip-service-certificate) to complete this step.
0 commit comments