allow2 / allow2ios

Allow2 Swift SDK for OpenSource Parental Freedom

Allow2iOS

Allow2 makes it easy to add parental controls to your apps.

1. Why should you use Allow2?
2. What's it look like?
3. Requirements
4. Integration

refer to https://github.com/Allow2/Allow2.github.io/wiki for more details.

Why should you use Allow2?

Parental controls are incredibly complex and difficult to get correct and for a parent, there is nothing worse than having to log in or open up yet another parental control interface on another app and reconfigure it every other day.

Allow2 solves the problem once and for all:

1. Leverage the powerful Allow2 platform completely for free (no developer licensing fees)
2. Add parental controls in a matter of hours and don't worry about implementing heaps of interfaces.
3. Show your community responsibility and support parents, this helps to bring more users to your apps.

Really, you should be able to add extensive and powerful parental controls to your apps in a matter of hours or (at most) a couple of days.

With Allow2 all you have to do to check if something can be used and record it's usage is:

let allow2Activities = [
    Allow2.Allow2Activity(activity: Allow2.Activity.Internet, log: true), // this is an internet based app
    Allow2.Allow2Activity(activity: Allow2.Activity.Gaming, log: true),   // and it's gaming related, can also use "Messaging", "Social", "Electricity" and more...
]
Allow2.shared.check(allow2Activities)

And don't worry about having to tell other parts of your app. It's done for you automatically (just listen for the Allow2CheckResultNotification)!

func Allow2CheckResultNotification(notification:NSNotification) {
    guard let userInfo = notification.userInfo,
    let result  = userInfo["result"] as? Allow2CheckResult else {
        print("No Allow2CheckResult found in notification")
        return
    }

    dispatch_async(dispatch_get_main_queue()) {
        self.allow2View.hidden = result.allowed

        if (!result.allowed) {
            // configure the block screen to explain the issue
            self.allow2View.result = result
        }
    }
}

What's it look like?

Screenshot	Description
	Pairing Initial Setup
	When there is more than one child, and the app can be used by any child
	Before a child can use the app, they need to enter their pin (if more than one child)
	If usage is not allowed at that time, or they ran out of quota, or have been banned.
	Children can request changes directly from within your game or app

Requirements

• iOS 8.0+ | macOS 10.10+ | tvOS 9.0+ | watchOS 2.0+
• Xcode 8

Integration

CocoaPods (iOS 9+)

You can use CocoaPods to install Allow2 by adding it to your Podfile:

platform :ios, '9.0'
use_frameworks!

target 'MyApp' do
    pod 'Allow2'
end

Note that this requires CocoaPods version 36, and your iOS deployment target to be at least 9.0:

Carthage (iOS 9+)

You can use Carthage to install Allow2 by adding it to your Cartfile:

github "Allow2/Allow2Framework"

Swift Package Manager

You can use The Swift Package Manager to install Allow2 by adding the proper description to your Package.swift file:

import PackageDescription

let package = Package(
name: "YOUR_PROJECT_NAME",
targets: [],
dependencies: [
.Package(url: "https://github.com/Allow2/allow2iOS.git", versions: Version(1,0,0)..<Version(2, .max, .max)),
]
)

Note that the Swift Package Manager is still in early design and development, for more information checkout its GitHub Page

Manually (iOS 9+)

To use this library in your project manually you may:

1. drag in the whole Allow2Framework.xcodeproj

Usage

Initialization

import Allow2

There are some basic options required to get started and some optional ones.

Create the app or device and get a token - REQUIRED

First of all, you need to set up the device in the developer portal, so head over there, signup (all free), and create your app/device:

https://developer.allow2.com/

then you need to set the token in the library before you can use any functions:

func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    ...
    
    Allow2.shared.deviceToken = "<DEVICE TOKEN GOES HERE>"
    
    ...
}

Set the environment - OPTIONAL

By default, the system will ALWAYS connect to the production environment. You can safely set up new apps in the developer portal and design and use them in the production system without any issues and this will be the most anyone will want to do.

However, the Allow2 platfom is also updated on a regular basis and as changes are bought to realisation, they flow through a standard release process that we allow developers to paticipate in. At this time, we allow developers to test in the "sandbox" environment (essentially "beta") and in the "staging" environment (essentially "alpha"). So you CAN set the system to use one of these environments, BUT use them at your own peril!

func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    ...

    Allow2.shared.env = .sandbox

    ...
}

Convenience setup - OPTIONAL

Allow2 for iOS provides a convenience setup in case you are building into multiple environments yourself, you can pass a plist (directly out of your bundle if you wish!) into the convience property setter to handle one line config and easily manage multiple build targets:

<key>Allow2</key>
<dict>
    <key>DeviceToken</key>
    <string>DEVICETOKEN</string>
    <key>Environment</key>
    <string>staging</string>
</dict>

Then you can pass this straight in from your Bundle:

func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    ...

    Allow2.shared.setPropsFromBundle(Bundle.main.infoDictionary?["Allow2"])

    ...
}

Any parameter that is not recognised will be ignored, so Environment: Invalid will essentially leave it as the default or whatever it was set to earlier.

allow2ios's Issues

Complete request view controller

to allow children to submit requests directly from the app

Complete cocoapods setup

Need to re-work the repo to a standard swift cocoapod setup and prepare for publication.

Add multiple child / access via PIN to allow for use on shared devices

Requirement of Sample code

I am trying to work on a project with parental control feature and came to know about the Allow2 SDK. I implemented the pods and I also added the restrictions code and notification observer code, but I got stuck with the communication between the parent-child devices. Also, how will they notify about event that would occur or will be restricted/needed to be restricted for specific time provided by the parent device.

can we like get access of what the child does in the apps mainly social media apps? is it possible using allows

Setup Carthage

Set up project to correctly support inclusion via Carthage

Sample Project Code

I've integrated the pod in my project which is basically a parent control app like "kidslox". But how to connect with parent-child device?. Any example project using this framework would be really helpful. thanks.