Appaloosa SDK

Overview

Appaloosa SDK library is a simple library that helps you to:

• Auto-update your application stored on Appaloosa Store server
• Manage authorizations for your application
• Prevent your application to run on a jailbroken device

Requirements

Appaloosa SDK library uses ARC and is compatible with iOS 8+.

/!\ In order to complete the setup for the features "Auto-update" and "Blacklist", the device must make at least one successful login on the native store to register its ADID to the server. /!\ Your App ID must be explicit (as opposed to wildcard) /!\ Testing on the simulator won't work

Integrate

Manually

• Download and import OTAppaloosa sources
• Add OTAppaloosa sources to your project.

Configure Appaloosa Agent

Once the Appaloosa SDK is integrated to your project, you need to configure the agent with the storeId and the storeToken.

• Register the Appaloosa Agent with your storeId and storeToken (you can find the storeId and storeToken on this page : http://www.appaloosa-store.com/settings).

• In your AppDelegate:applicationDidBecomeActive() add the register Appaloosa Agent.

objective-c

[[OTAppaloosaAgent sharedAgent] registerWithStoreId:APPALOOSA_STORE_ID storeToken:APPALOOSA_STORE_TOKEN
andDelegate:self];

swift

OTAppaloosaAgent.shared().register(
withStoreId: APPALOOSA_STORE_ID,
storeToken: APPALOOSA_STORE_TOKEN)

Check for application update - simple version

objective-c

1. In your AppDelegate.m file, launch the autoupdate when your application starts :
2. Import the plugin: #import "OTAppaloosa.h"
3. Register the Appaloosa Agent with StoreId and StoreToken
4. In method - (void)applicationDidBecomeActive:(UIApplication *)application, add the following code line:

[[OTAppaloosaAgent sharedAgent] checkUpdates];

swift

1. In your AppDelegate.swift file, launch the autoupdate when your application starts :
2. Import the plugin: import OTAppaloosa
3. Register the Appaloosa Agent with StoreId and StoreToken
4. In method AppDelegate:applicationDidBecomeActive(), add the following code line:

OTAppaloosaAgent.shared().checkUpdates()

Check for application update - clever version

objective-c

1. Into your AppDelegate.h file
2. Import the plugin: #import "OTAppaloosa.h"
3. Add the OTAppaloosaAgentDelegate into your interface:

@interface AppDelegate : UIResponder <UIApplicationDelegate, OTAppaloosaAgentDelegate>

2. Into your AppDelegate.m file, launch the autoupdate when your application starts :
3. Register the Appaloosa Agent (storeId + storeToken)
4. In method - (void)applicationDidBecomeActive:(UIApplication *)application, add the following code line:

[[OTAppaloosaAgent sharedAgent] checkUpdates];

3. Implement delegate methods if you want your own behaviour :
4. The method - (void)applicationUpdateRequestSuccessWithApplicationUpdateStatus:(OTAppaloosaUpdateStatus)appUpdateStatusto inform the application needs to be updated. You need to analyze the 'appUpdateStatus' to know if an update is available and download the new version. By default,

• if the application is up to date, nothing occures.
• if an update is available, an alert view asks the user to download it. If you want to launch the download : [[OTAppaloosaAgent sharedAgent] downloadNewVersion];

2. The method - (void)applicationUpdateRequestFailureWithError:(NSError *)error to be inform if something wrong occured during the update request.

swift

1. Into your AppDelegate.swift file
2. Import the plugin: import OTAppaloosa
3. Add the OTAppaloosaAgentDelegate into your interface:

class AppDelegate: UIResponder, UIApplicationDelegate, OTAppaloosaAgentDelegate

2. Into your AppDelegate.swift file, launch the autoupdate when your application starts :
3. Register the Appaloosa Agent (storeId + storeToken)
4. In method AppDelegate:applicationDidBecomeActive(), add the following code line:

OTAppaloosaAgent.shared().register(
withStoreId: APPALOOSA_STORE_ID,
storeToken: APPALOOSA_STORE_TOKEN, andDelegate: self)
OTAppaloosaAgent.shared().checkUpdates()

3. Implement delegate methods if you want your own behaviour :
4. The method - func applicationUpdateRequestSuccess(withApplicationUpdateStatus appUpdateStatus: OTAppaloosaUpdateStatus)to inform the application needs to be updated. You need to analyze the 'appUpdateStatus' to know if an update is available and download the new version. By default,

• if the application is up to date, nothing occures.
• if an update is available, an alert view asks the user to download it. If you want to launch the download : OTAppaloosaAgent.shared().downloadNewVersion()

Check authorizations for application

This SDK provides a kill switch mecanism. From the web interface (http://www.appaloosa-store.com/), you are able to authorize or not a device to access the application. The mecanism works offline by reading the blacklisted status from the keychain.

In your appDelegate add the following line to check authorizations when the application becomes active - (void)applicationDidBecomeActive:(UIApplication *)application:

objective-c

[[OTAppaloosaAgent sharedAgent] checkAuthorizations];

swift

OTAppaloosaAgent.shared().checkAuthorizations()

By default :

• if the user is authorized, nothing occurs.
• if the user is not authorized, an alert view is displayed with the appropriated message and the application is killed.

If you prefer to develop your own behaviour, you should implement the OTAppaloosaAgentDelegate :

• to know if the user is authorized : - (void)applicationAuthorizationsAllowed;
• to know if the user is not authorized : - (void)applicationAuthorizationsNotAllowedWithStatus:(OTAppaloosaAutorizationsStatus)status andMessage:(NSString *)message

Check if the device is jailbroken

You can prevent your app from running on a jailbroken device.

In your appDelegate file, add the following line to check authorizations when the application becomes active - (void)applicationDidBecomeActive:(UIApplication *)application:

objective-c

[[OTAppaloosaAgent sharedAgent] blockJailbrokenDevice];

swift

OTAppaloosaAgent.shared().blockJailbrokenDevice()

Want some documentation?

Appaloosa SDK for iOS use AppleDoc to generate its API's documentation.

License

Copyright (C) 2012 Appaloosa (https://www.appaloosa-store.com)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.