Install Guide Document
To use the BlinkUp SDK, copy BlinkUp.embeddedframework
to your project directory, drag the framework into Xcode’s organizer window, and add the -ObjC
linker flag.
Objective-C Framework Installation
- Unzip
BlinkUpSDK.zip
. - Drag
BlinkUp.embeddedframework
from theBlinkUpSDK/BlinkUp
directory to the project organizer in Xcode (SelectCopy items into destination group's folder
). - In the build settings for your project (or application target) add
-ObjC
to theother linker flags
if it does not already exist. Add the following system frameworks to your project if they aren’t linked already:
- AVFoundation.framework
- CoreGraphics.framework
- Metal.framework
- OpenGLES.framework
- QuartzCore.framework
- Security.Framework
- SystemConfiguration.framework
Swift Framework Installation
- Unzip
BlinkUpSDK.zip
. - Drag
BlinkUp.embeddedframework
from theBlinkUpSDK/BlinkUp
directory to the project organizer in Xcode (SelectCopy items into destination group's folder
). - In the build settings for your project (or application target) add
-ObjC
to theother linker flags
if it does not already exist. - Copy the folder
BlinkUpSDK/BlinkUp/BlinkUpSwiftExtensions
into your project. This is optional and provides a few Swift wrapper functions for methods with many block parameters. - Add
import BlinkUp
to the Swift file you are implementing BlinkUp in.
Swift Notes
The Swift BlinkUp extensions are optional, but provide enumeration based closures rather than the more verbose Objectice-C blocks. The extension functions are not found in this documentation. It is recommended to review the .swift
files in the BlinkUpSwiftExtensions folder to view the additional functions provided.
SDK Configuration
The SDK contains a few global configuration options. These should be configured in the AppDelegate
application:didFinishLaunchingWithOptions
method.
Objective-C
//At the top of your application delegate import the BlinkUp Framework
#import <BlinkUp/BlinkUp.h>
// In the application:didFinishLaunchingWithOptions method insert
// If you are using a private cloud host or other SDK features
// call the appropriate configure method
[BUSDK configure];
Swift
//At the top of your application delegate import the BlinkUp Framework
import BlinkUp
// In the application:didFinishLaunchingWithOptions method insert
// If you are using a private cloud host or other SDK features
// call the appropriate configure method
BUSDK.configure()
Next Steps
For easy setup and a standardized interface, please read the Basic BlinkUp guide. To implement a custom user experience or more complex behaviours, please read the Custom BlinkUp guide.
To accompany each of these guides, there are custom application templates (one for basic and one for custom) included in the SDK as examples of implementation.