Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artificialsolutions/tie-api-client-ios
Swift/Objective C SDK that handles communication with the Teneo Interaction Engine.
https://github.com/artificialsolutions/tie-api-client-ios
cocoapods objective-c sdk swift teneo xcode
Last synced: 5 days ago
JSON representation
Swift/Objective C SDK that handles communication with the Teneo Interaction Engine.
- Host: GitHub
- URL: https://github.com/artificialsolutions/tie-api-client-ios
- Owner: artificialsolutions
- License: apache-2.0
- Created: 2018-10-02T08:55:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-02T12:31:59.000Z (over 5 years ago)
- Last Synced: 2024-09-21T07:03:18.448Z (5 months ago)
- Topics: cocoapods, objective-c, sdk, swift, teneo, xcode
- Language: Swift
- Homepage: https://developers.artificial-solutions.com
- Size: 60.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TIE API Client
> [!IMPORTANT]
> This project has been retired and archived
> If there is a need of continued use / development of this project for your own needs please feel free to fork the project - which will remain here in archived form.
This library provides a way of communicating with a Teneo Engine server instance
## Requirements
- iOS 12.0+
- Xcode 11.0+
- Swift 5.0+
## Basic Use
### Setup
**Must be called before calling sendInput or closeSession**
```swift
do {
try TieApiService.sharedInstance.setup("BASE_URL", endpoint: "ENDPOINT")
} catch {
// Handle errors here
}
```
### Send Input
```swift
TieApiService.sharedInstance.sendInput({MESSAGE},
parameters: {PARAMETERS},
success: { response in
// Handle response. Remember to dispatch to main thread if updating UI
}, failure: { error in
// Handle error
})
```
### Close Session
```swift
TieApiService.sharedInstance.closeSession({ response in
// Handle response. Remember to dispatch to main thread if updating UI
}, failure: { error in
// Handle error
})
```
## Installation
### CocoaPods
[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
> CocoaPods 1.5+ is required to build TieApiClient 1.0.0+.
To integrate TieApiClient into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
pod "TieApiClient"
```
Then, run the following command:
```bash
$ pod install
```
## License
TieApiClient is released under the Apache License, Version 2.0. [See LICENSE](https://github.com/artificialsolutions/tie-api-client-ios/blob/master/LICENSE) for details.