Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opentok/accelerator-textchat-ios
OpenTok Text Chat Accelerator Pack enables text messages between mobile or browser-based devices.
https://github.com/opentok/accelerator-textchat-ios
communication ios objective-c opentok real-time realtime realtime-messaging textchat tokbox webrtc
Last synced: 3 months ago
JSON representation
OpenTok Text Chat Accelerator Pack enables text messages between mobile or browser-based devices.
- Host: GitHub
- URL: https://github.com/opentok/accelerator-textchat-ios
- Owner: opentok
- License: mit
- Archived: true
- Created: 2017-01-30T18:03:43.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2021-03-22T09:42:40.000Z (over 3 years ago)
- Last Synced: 2024-08-12T22:29:44.210Z (3 months ago)
- Topics: communication, ios, objective-c, opentok, real-time, realtime, realtime-messaging, textchat, tokbox, webrtc
- Language: Objective-C
- Homepage: https://tokbox.com/
- Size: 414 KB
- Stars: 13
- Watchers: 71
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ios - OTTextChatAccelerator - OpenTok Text Chat Accelerator Pack enables text messages between mobile or browser-based devices. (Messaging / Video)
- awesome-ios-star - OTTextChatAccelerator - OpenTok Text Chat Accelerator Pack enables text messages between mobile or browser-based devices. (Messaging / Video)
README
# Text Chat Accelerator Pack iOS
[](https://travis-ci.org/opentok/accelerator-textchat-ios)
[](https://cocoapods.org/pods/OTTextChatAccelerator)
[](https://cocoapods.org/pods/OTTextChatAccelerator)
[](https://cocoapods.org/pods/OTTextChatAccelerator)
[](http://makeapullrequest.com)
[](https://codebeat.co/projects/github-com-opentok-accelerator-textchat-ios)
# **This project is deprecated**
## The OpenTok Text Chat Accelerator Pack for iOS project is now a part of [Accelerator Core iOS](https://github.com/opentok/accelerator-core-ios)
The Text Chat Accelerator Pack provides functionality you can add to your OpenTok applications that enables users to exchange text messages between mobile or browser-based devices.
## Text Chat Accelerator Pack Examples
 
## Configure, build and run the sample app
1. Get values for **API Key**, **Session ID**, and **Token**. See [Obtaining OpenTok Credentials](#obtaining-opentok-credentials) for important information.
1. Install CocoaPods as described in [CocoaPods Getting Started](https://guides.cocoapods.org/using/getting-started.html#getting-started). If you are only interested in the core part without UI component, you can use this `pod 'OTTextChatAccelerator/Core'`
1. In Terminal, `cd` to your project directory and type `pod install`.
1. Reopen your project in Xcode using the new `*.xcworkspace` file.
1. Replace the following empty strings with the corresponding API Key, Session ID, and Token values:
```objc
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Override point for customization after application launch.
sharedSession = [[OTAcceleratorSession alloc] initWithOpenTokApiKey:@"apikey" sessionId:@"sessionid" token:@"token"];
return YES;
}
```
1. Use Xcode to build and run the app on an iOS simulator or device.
1. For testing text chat, we include a simple web app to make it easier: [Browser-Demo-TextChat](https://github.com/opentok/accelerator-textchat-ios/blob/master/browser-demo-textchat.html). Simply open it and replace the corresponding API Key, Session ID, and Token values. Then save and load it to the browser.
1. You might want to run on other platforms:
[Accelerator Textchat Javascript](https://github.com/opentok/accelerator-textchat-js)
[Accelerator Textchat Android](https://github.com/opentok/accelerator-textchat-android)
## Sample Codes
- Passing the session
```objc
- (OTAcceleratorSession *)sessionOfOTOneToOneCommunicator:(OTOneToOneCommunicator *)oneToOneCommunicator {
return <#OTAcceleratorSession#>;
}
```
- Start signaling text chat data
```objc
// we assume self owns a table tableView
[self.textChat connectWithHandler:^(OTTextChatConnectionEventSignal signal, OTConnection *connection, NSError *error) {
if (signal == OTTextChatConnectionEventSignalDidConnect) {
NSLog(@"Text Chat starts");
}
else if (signal == OTTextChatConnectionEventSignalDidDisconnect) {
NSLog(@"Text Chat stops");
}
} messageHandler:^(OTTextChatMessageEventSignal signal, OTTextMessage *message, NSError *error) {
if (signal == OTTextChatMessageEventSignalDidSendMessage || signal == OTTextChatMessageEventSignalDidReceiveMessage) {
if (!error) {
[weakSelf.textMessages addObject:message];
[weakSelf.tableView reloadData];
}
}
}];
```
- Stop signaling text chat data
```objc
[self.textchat disconnect];
```
#### Obtaining OpenTok Credentials
To use OpenTok's framework you need a Session ID, Token, and API Key you can get these values at the [OpenTok Developer Dashboard](https://dashboard.tokbox.com/) . For production deployment, you must generate the Session ID and Token values using one of the [OpenTok Server SDKs](https://tokbox.com/developer/sdks/server/).
## JSON Requirements for Text Chat Signaling
The JSON used when using the OpenTok signaling API with the OpenTok Text Chat component describes the information used when submitting a chat message. This information includes the date, chat message text, sender alias, and sender ID. The JSON is formatted as shown in this example:
``` javascript
// var type = "text-chat"
```
```json
{
"sentOn" : 1462396461923.305,
"text" : "Hi",
"sender" : {
"alias" : "Tokboxer",
"id" : "16FEB40D-C09B-4491-A983-44677B7EBB3E"
}
}
```
This formatted JSON is converted to a string, which is submitted to the OpenTok signaling API. For more information, see:
- [Signaling - JavaScript](https://tokbox.com/developer/guides/signaling/js/)
- [Signaling - iOS](https://tokbox.com/developer/guides/signaling/ios/)
- [Signaling - Android](https://tokbox.com/developer/guides/signaling/android/)
## Development and Contributing
Interested in contributing? We :heart: pull requests! See the [Contribution](CONTRIBUTING.md) guidelines.
## Getting Help
We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:
- Open an issue on this repository
- See for support options
- Tweet at us! We're [@VonageDev](https://twitter.com/VonageDev) on Twitter
- Or [join the Vonage Developer Community Slack](https://developer.nexmo.com/community/slack)
## Further Reading
- Check out the Developer Documentation at