🚀 Getting Started

Guide and instructions for setting up the Numberly SDK for iOS apps

1. Install the SDK¶

target 'MyApp' do
    pod 'Numberly'
end

2. Create and add the configuration file¶

Open the project .xcworkspace and create a Numberly.plist file. Make sure that it's included to your application’s target.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>app_key</key>
    <string>the app key provided by numberly</string>
    <key>automatic_integration</key>
    <true/>
    <key>automatic_notification_registration</key>
    <true/>
</dict>
</plist>

Options¶

You can customize the configuration with the following properties:

3. Enable push capabilities¶

Add the Push Notification capability to your project by following this guide.

4. Start the SDK¶

Here we are! Now you can simply start Numberly in the AppDelegate's application:didFinishLaunchingWithOptions: method:

import Numberly

func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions
                    launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    Numberly.start()
    ...
}

@import Numberly;

- (BOOL)application:(UIApplication *)application 
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    
    [Numberly start];
    ...
}

Troubleshooting¶

If you want to validate your implementation you can active the Numberly logs:

Numberly.logLevel = .debug

Numberly.logLevel = NBLLogLevelDebug;