https://github.com/stomt/stomt-ios-sdk
iOS SDK for the STOMT API
https://github.com/stomt/stomt-ios-sdk
cocoapods community community-management feedback feedback-collection feedback-loop feedback-systems ios ios-app ios-sdk mass-relationship-management stomt
Last synced: 6 months ago
JSON representation
iOS SDK for the STOMT API
- Host: GitHub
- URL: https://github.com/stomt/stomt-ios-sdk
- Owner: stomt
- License: mit
- Created: 2015-09-09T10:58:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-25T19:09:36.000Z (over 7 years ago)
- Last Synced: 2024-10-31T00:50:40.103Z (7 months ago)
- Topics: cocoapods, community, community-management, feedback, feedback-collection, feedback-loop, feedback-systems, ios, ios-app, ios-sdk, mass-relationship-management, stomt
- Language: Objective-C
- Homepage: https://www.stomt.com
- Size: 1.63 MB
- Stars: 6
- Watchers: 8
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# DEPRECATED! [NEW SWIFT SDK AVAILABLE](https://github.com/stomt/stomt-swift-sdk)
# stomt iOS-SDK [](https://travis-ci.org/stomt/stomt-ios-sdk) [](https://rest.stomt.com/) [](https://github.com/stomt/ios-sdk)
Our SDK allows you to add the feedback solution [www.stomt.com](https://www.stomt.com/) to your iPhone or iPad app.
To connect your app to stomt, [create a project page on stomt](https://www.stomt.com/createTarget) first.
## Installation
To install the stomt-iOS-SDK you have multiple choices.
### CocoaPods - (Easiest method)
Add the SDK to your app by adding the following line into your Podfile.
```
pod 'Stomt-iOS-SDK', '~> 0.0.x'
```
### Versioning for pod
From version *2.0.2* the pod works for iOS 8/9/10 seamlessly.
### Manually
- Issue from command line `git clone https://github.com/stomt/stomt-ios-sdk` to download the github project.
- Locate `StomtiOS.xcodeproj` in the cloned repo and drag it into your current Xcode project. **Be sure to place it outside your project hierarchy!**
- Goto *Build Phases* pane of your app and add **StomtiOS.framework** inside *Link Bynary With Libraries*.
Done!
## Configuration
Import the SDK:
**(If installed via CocoaPods)**
```Objective-C
#import "Stomt.h"
```
**(If installed manually)**
```Objective-C
#import
```
Initialize the framework:
```Objective-C
// Setup Stomt with your AppID
// -> get yours at: https://www.stomt.com/dev/my-apps
//
[Stomt setAppID:@"abcdefghijklmnopqrstuvwxy"];
```
## Documentation
###Common Usages
####Create a stomt
The most common action while using the SDK is to send a Stomt.
```Objective-C
// Open a creation modal for your applications page
// -> the targetID is your pages identifier you can copy it from the pages url
// https://www.stomt.com/stomt-ios-sdk -> stomt-ios-sdk
//
[Stomt presentStomtCreationPanelWithTargetID:@"target-id"
defaultText:@"..."
likeOrWish:kSTObjectWish
fromViewController:self
completionBlock:^(NSError *error, STObject *stomt) {
}];
```
####Authenticate
Authentication to Stomt can be accomplished in two ways:
Via normal OAuth flow, using the handy class method `+[Stomt promptAuthenticationIfNecessaryWithCompletionBlock:]`
You also have to provide your app with the url schema "stomtAPI" and override the following methods in your *AppDelegate*
```
//For iOS 8
- (BOOL)application:(UIApplication*)application openURL:(nonnull NSURL *)url sourceApplication:(nullable NSString *)sourceApplication annotation:(nonnull id)annotation
{
return [[Stomt sharedInstance] application:application openURL:url sourceApplication:nil annotation:nil];
}
//For iOS 9 or higher
- (BOOL)application:(UIApplication *)application openURL:(nonnull NSURL *)url options:(nonnull NSDictionary *)options
{
return [[Stomt sharedInstance] application:application openURL:url sourceApplication:nil annotation:nil];
}
```
*This is still on development. It will be updated soon, please check for updates.*
Or via **Facebook connect**.
**Documentation coming soon!**
## Contribution
We would love to see you contributing to our iOS SDK. Feel free to fork it and we're also awaiting your pull-requests!
## Authors
* [Leonardo Cascianelli](https://github.com/h3xept)
* [Max Klenk](https://github.com/maxklenk)
## More about stomt
* On the web [www.stomt.com](https://www.stomt.com)
* [stomt for iOS](http://stomt.co/ios)
* [stomt for Android](http://stomt.co/android)