react-native-twilio-ip-messaging
v0.3.0
Published
React Native wrapper for Twilio IP Messaging SDKs
Downloads
66
Maintainers
Readme
React Native Twilio IP Messaging (Deprecated)
NOTE: This package is for the original Twilio IP Messaging SDKs. If you are using the newer Twilio Chat SDKs, please use our new package react-native-twilio-chat for the correct wrappers.
####Changelog
Installation
npm install --save react-native-twilio-ip-messaging
iOS, option 1 (not working well with react native 0.40.0 at the moment)
Install the Twilio IP Messaging SDK and this package via CocoaPods.
See the full Podfile example for more details.
pod 'RCTTwilioIPMessaging', :path => '../node_modules/react-native-twilio-ip-messaging/ios'
source 'https://github.com/twilio/cocoapod-specs'
pod 'TwilioIPMessagingClient', '~> 0.14.2'
Note: the underlying Twilio SDKs require a minimum deployment target of 8.1
. If your project's target is less than this you will get a CocoaPods install error (Unable to satisfy the following requirements...
).
Make sure that you add the $(inherited)
value to Other Linker Flags
and Framework Search Paths
for your target's Build Settings. This is also assuming you have already loaded React via CocoaPods as well.
iOS, option 2 - manually
The twilio part of your Podfile would look like this
source 'https://github.com/twilio/cocoapod-specs'
pod 'TwilioIPMessagingClient', '~> 0.14.2'
- Open your project in Xcode, right click on
Libraries
and clickAdd Files to "Your Project Name"
Look undernode_modules/react-native-twilio-ip-messaging/ios
and addRCTTwilioIPMessaging.xcodeproj
. - Add
libRCTTwilioIPMessageing.a
to `Build Phases -> Link Binary With Libraries. - Click on
RCTTwilioIPMessaging.xcodeproj
inLibraries
and go theBuild Settings
tab. Double click the text to the right ofHeader Search Paths
and verify that it has$(SRCROOT)/../../react-native/React
as well as$(SRCROOT)/../../../ios/Pods/Headers
- if they aren't, then add them.
Android
In android/settings.gradle
:
include ':RCTTwilioIPMessaging', ':app'
project(':RCTTwilioIPMessaging').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-twilio-ip-messaging/android')
In android/app/build.gradle
:
...
dependencies {
...
compile project(':RCTTwilioIPMessaging')
}
Register the module in MainActivity.java
by calling addPackage():
// import package
import com.bradbumbalough.RCTTwilioIPMessaging.RCTTwilioIPMessagingPackage;
...
// register package in getPackages()
@Override
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
... other packages
new RCTTwilioIPMessagingPackage(),
new MainReactPackage()
);
}
Note: You might have to enable multidex in your build.gradle
file and increase the heap size if you're getting errors while buliding. The minSdkVersion must also be at least 19, per the Twilio SDKs.
android {
....
dexOptions {
javaMaxHeapSize "2048M"
}
defaultConfig {
...
minSdkVersion 19
multiDexEnabled true
}
Usage
/* Initialization */
let {
AccessManager,
Client,
Constants
} = require('react-native-twilio-ip-messaging')
// create the access manager
var accessManager = new AccessManager(token);
// specify any handlers for events
accessManager.onTokenExpired = () => {
getNewTokenFromServer()
.then(accessManager.updateToken)
}
// create the client
var client = new Client(accessManager);
// specify any global events
client.onError = ({error, userInfo}) => console.log(error)
// initialize the client
client.initialize()
// wait for sync to finish
client.onClientSynchronized = () => {
client.getChannels()
.then((channels) => console.log(channels))
}
/* Individual Channel */
// somehow an instance of Channel is passed down in the app
var channel = this.props.channel
// specify channel specific events
channel.onMessageAdded = (message) => console.log(message.author + ": " + message.body)
channel.onTypingStarted = (member) => console.log(member.identity + " started typing...")
channel.onTypingEnded = (member) => console.log(member.identity + " stopped typing...")
channel.onMemberAdded = (member) => console.log(member.identity + " joined " + channel.friendlyName)
// sending a message
<TextInput
onChangeText={(body) => {
this.setState({body})
channel.typing()
}}
onSubmitEditing={() => channel.sendMessage(this.state.body)}
/>
####Documentation