sequencing-file-selector-api-objc 1.3.2

sequencing-file-selector-api-objc 1.3.2

×

TestsTested ✗
LangLanguage Obj-CObjective C
License MIT
ReleasedLast Release Mar 2017

Maintained by Bogdan Laukhin, Alex Moskvin.

sequencing-file-selector-api-objc 1.3.2

  • By
  • Sequencing

File Selector CocoPod plugin for adding Sequencing.com's Real-Time Personalization technology to iOS apps coded in Objective-C

This repo contains the plug-n-play CocoaPods plugin for implementing a customizable File Selector so your app can access files stored securely at Sequencing.com.

This CocoPod can be used to quickly add a File Selector to your app. By adding this File Selector to your app, you're app user will be able to select a file stored securely in the user's Sequencing.com account. Your app will then be able to use the genetic data in this file to provide the user with Real-Time Personalization.

While the File Selector works out-of-the-box, it is also fully customizable.

A 'Master CocoaPods Plugin' is also available. The Master Plugin contains a customizable, end-to-end solution that quickly adds all necessary code to your app for Sequencing.com's Real-Time Personalization.

Once the Master Plugin is added to your app all you'll need to do is:

  1. add your OAuth2 secret
  2. add one or more App Chain numbers
  3. configure your app based on each app chain's possible responses

To code Real-Time Personalization technology into apps, developers may register for a free account at Sequencing.com. App development with RTP is always free.

Related repos

Master Plugin is available in the following languages:

File Selector is available in the following languages: File Selector Plugins

File Selector Code

Contents

  • Related repos
  • Cocoa Pod integration
  • Resources
  • Maintainers
  • Contribute

Cocoa Pod integration

Please follow this guide to install File Selector module in your existed or new project.

Step 1: Install oAuth module and File Selector modules

  • see general CocoaPods instruction 

    https://cocoapods.org > getting started

  • oAuth CocoaaPods plugin reference: Objective-C (CocoaPod plugin)

  • File selector module prepared as separate module, but it depends on a Token object from oAuth module. File selector can execute request to server for files with token object only. Thus you need 2 modules to be installed: oAuth module and File Selector module

  • create a new project in Xcode

  • create Podfile in your project directory: 

    $ pod init

  • specify following parameters in Podfile: 

    pod 'sequencing-file-selector-api-objc', '~> 1.3.2'

  • install the dependency in your project: 

    $ pod install

  • always open the Xcode workspace instead of the project file: 

    $ open *.xcworkspace

Step 2: Set up OAuth module

Step 3: Use File Selector

  • add file selector protocol import in your class were you getting and handling file selector:

    #import "SQFileSelectorProtocol.h"

  • subscribe your class to file selector protocol: 

    <SQFileSelectorProtocol>

  • add import: 

    #import "SQFilesAPI.h"

  • also add import of SQOAuth from OAuth plugin: 

    #import "SQOAuth.h"

  • implement methods from SQFileSelectorProtocol protocol

    - (void)selectedGeneticFile:(NSDictionary *)file {
}


- (void)errorWhileReceivingGeneticFiles:(NSError *)error {
}


- (void)closeButtonPressed {
}

  • call file selector via method showFilesWithTokenProvider: showCloseButton: previouslySelectedFileID: delegate:

    - (void)showFilesWithTokenProvider:(id<SQTokenAccessProtocol>)tokenProvider
                showCloseButton:(BOOL)showCloseButton
                previouslySelectedFileID:(NSString *)selectedFileID
                delegate:(UIViewController<SQFileSelectorProtocol> *)delegate;

    where

    tokenProvider - provide SQOAuth instance (as [SQOAuth sharedInstance])
showCloseButton - provide BOOL value to specify if you want to have Close button ability
selectedFileID - provide file ID if you want to specific file be preselected
delegate - provide UIViewController class instance that conforms to "SQFileSelectorProtocol" protocol

  • when user selects any file and clics on "Continue" button in UI - selectedGeneticFile: method from SQFileSelectorProtocol protocol will be called then. Selected file will be passed on as a parameter. In this method you can handle selected file

  • each file is a NSDictionary object with following keys and values format:

    key name type description
    DateAdded String date file was added
    Ext String file extension
    FileCategory String file category: Community, Uploaded, FromApps, Altruist
    FileSubType String file subtype
    FileType String file type
    FriendlyDesc1 String person name for sample files
    FriendlyDesc2 String person description for sample files
    Id String file ID
    Name String file name
    Population String
    Sex String the sex

Resources

Maintainers

This repo is actively maintained by Sequencing.com. Email the Sequencing.com bioinformatics team at [email protected] if you require any more information or just to say hola.

Contribute

We encourage you to passionately fork us. If interested in updating the master branch, please send us a pull request. If the changes contribute positively, we'll let it ride.