Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ebbapp/ebblinkSDK
iOS SDK to share JPEG images with an expiration date
https://github.com/ebbapp/ebblinkSDK
Last synced: 3 months ago
JSON representation
iOS SDK to share JPEG images with an expiration date
- Host: GitHub
- URL: https://github.com/ebbapp/ebblinkSDK
- Owner: ebbapp
- License: other
- Created: 2016-10-02T16:40:28.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-06T21:52:50.000Z (over 6 years ago)
- Last Synced: 2024-04-22T04:15:54.656Z (7 months ago)
- Language: Objective-C
- Homepage: http://www.fiveopenbooks.com
- Size: 5.6 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-ios - Ebblink - An iOS SDK for sharing photos that automatically expire and can be deleted at any time. (Media / Image)
- awesome-ios-star - Ebblink - An iOS SDK for sharing photos that automatically expire and can be deleted at any time. (Media / Image)
README
Ebblink iOS SDK
==============
A library to integrate Ebblink private image sharing capabilities into your iOS app.
Table of Contents
=================
**Getting Started**
1. [Requirements](#requirements)
2. [Setup](#setup)
3. [Quick Start](#quick-start)
4. [Terms and Conditions](#terms-and-conditions)
Requirements
--------------
- iOS 8+
Setup
-------------
Add the following to your Podfile:
```sh
pod 'ebblinkSDK', :git => 'https://github.com/ebbapp/ebblinkSDK'
```
Quick Start
-------------
##### Instantiate Ebblink iOS SDK
To get a token send us email at [email protected]
The userId is a parameter that identifies a unique user. You can use any string such that the
identifier is unique, for example the user email.
```Objective-C
+ (void)initWithToken:(NSString*)token andUserId:(NSString*)userId;
```
##### Set processing mode
There are two possible processing modes:
- ```Device```: the encryption and decryption of the image is performed on the user's device. This means that the image is uploaded to our servers fully encrypted.
- ```Server```: the encryption and decryption of the image is performed on our server. This means that during the network data transfer from our servers to the device the image is not encrypted. The processing time may vary depending on the device specifications. By default the processing mode is ```Device```.
```Objective-C
+ (void)setProcessingMode:(EBProcessingMode)processingMode;
```
##### Upload a new image
```Objective-C
+ (void) p3ImageUpload:(UIImage*)image duration:(NSNumber*) duration completion:(void (^)(NSString* imageId, NSString* password, NSString* publicLink, NSString* error))completionBlock;
```
##### View shared image
```Objective-C
+ (void) p3ImageView:(NSString*)imageId withPassword:(NSString*)password completion:(void (^)(UIImage* image, NSString* error))completionBlock;
```
##### Check image status
```Objective-C
+ (void) p3ImageStatus:(NSString*)imageId completion:(void (^)(NSDictionary* dictionary, NSString* error))completionBlock;
```
##### Delete image shared image
```Objective-C
+ (void) p3ImageKill:(NSString*)imageId completion:(void (^)(BOOL success, NSString* error))completionBlock;
```
##### Upload an image as a story
A story is an image that is linked to the user and available for only 24h from the moment it is uploaded. The completion block returns an imageId that is needed if one wants to manually delete the image before the 24h.
```Objective-C
+ (void) p3ImageStoryUpload:(UIImage*)image completion:(void (^)(NSString* imageId, NSString* error))completionBlock;
```
##### View the stories of a user
Calling this method and passing a userId will return in the completion block an EBUserStory object that contains all the available stories from that user.
```Objective-C
+ (void) p3UserStoryView:(NSString*)userId completion:(void (^)(EBUserStory *story, NSString* error))completionBlock;;
```
Terms and Conditions
----------------
You can find our terms and conditions in the following url:
[http://www.fiveopenbooks.com/terms](http://www.fiveopenbooks.com/terms)