DonkySDK-Android-Modular (V2.8.0.0)

The Android Modular SDK is a kit for adding push notifications and rich content services to your application. For detailed documentation, tutorials and guides, visit our online documentation.

Requirements

• Android 4.0+

Author

• Donky Networks Ltd, [email protected]

License

• Donky-Core-SDK is available under the MIT license. See the LICENSE file for more info.

##Support

• Please contact [email protected] if you have any issues with integrating or using this SDK.

Donky Core SDK

• Donky Core SDK (Requried for all implementations of the Donky SDK.)

Modules

• Core Analytics
• Assets
• Automation
• Sequencing
• Location
• Push
• Rich Messaging Logic
• Rich Messaging Inbox UI
• Common Messaging (Logic + UI)

Core Module dependencies

• com.google.android.gms:play-services-gcm
• com.squareup.retrofit2:retrofit (http://square.github.io/retrofit/)
• com.squareup.okhttp3:okhttp (http://square.github.io/okhttp/)
• com.google.code.gson (https://code.google.com/p/google-gson/)

Donky-Core-SDK

Provides the basics of any Donky integration into your apps. The Core SDK is responsible for handling:

• Registration onto the Donky Network
• Control of User and Device registration details
• Sending and receiving content

Source

You can find the source code of Donky Core in Donky/core Android Studio project. You can use 'File->New->Import Module' option to easily include the source code to your project.

Usage

To read more about how to get started please see here and for details how to use this module here.

Download via Gradle

    compile 'net.donky:donky-core:2.8.0.0'

Standard Mode

Initialise this module in onCreate method of your application class.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
			
		DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<",
			new DonkyListener() /*set callback handlers*/);
			
    }
  
}

Authenticated Mode

You can delegate authentication responsibility to another trusted system that can issue a JWT containing the required information. In order to be able to register to Donky Network in a secured way you need to provide a callback that will respond to authentication challenges and provide a valid JWT token.

class Authenticator implements DonkyAuthenticator {

  @Override
  public void onAuthenticationChallenge(DonkyAuthClient authClient,
                                        ChallengeOptions options) {
    
    /**
     * Obtain JWT token based on a given nonce and return the value to
     * authClient instance. At this point the user authentication process will 
     * be able to continue automatically.
     * options.getNonce() for nonce to be included in token
     * options.getForUserId() expected user id when re-authenticating
     */
     authClient.authenticateWithToken("TEST_TOKEN");
   }

}

Initialise this module in onCreate method of your application class with an instance of the DonkyAuthenticator class you created.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
      
        DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<",
          new Authenticator() /* extends DonkyAuthenticator */, 
          new DonkyListener() /*set callback handlers*/);
    }
  
}

For more details on authentication please visit documaentation page

Donky-Push

Use the Push module to enable your application to receive Push messages.

Source

You can find the source code of Donky Core in Donky/push Android Studio project. You can use 'File->New->Import Module' option to easily include the source code to your project.

Usage

To read more about how to get started please see here and for details how to use this module here.

Download via Gradle

    compile 'net.donky:donky-module-push:2.8.0.0'

Initialise this module before initailising Donky Core in onCreate method of your application class.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
      
		DonkyPush.initialiseDonkyPush(this, true,
			new DonkyListener() /*set callback handlers*/);
      
		DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<", 
			new DonkyListener() /*set callback handlers*/);
    		
	}
}

Donky-RichMessage-Logic

Use the Rich Message module to enable your application to receive rich content messages.

Source

You can find the source code of Donky Rich Logic in Donky/richlogic Android Studio project. You can use 'File->New->Import Module' option to easily include the source code to your project.

Usage

To read more about how to get started please see here and for details how to use this module here.

Download via Gradle

    compile 'net.donky:donky-module-rich-logic:2.8.0.0'

Initialise this module before initailising Donky Core in onCreate method of your application class.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
      
        DonkyRichLogic.initialiseDonkyRich(this,
			new DonkyListener() /*set callback handlers*/);
      
		DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<", 
        	new DonkyListener() /*set callback handlers*/);
    		
	}
}

Donky-RichMessage-Inbox-UI

Use the Rich Messaging Inbox module to enable your application to disply rich messaging inbox and rich messages.

Source

You can find the source code of Donky Rich Inbox UI in Donky/richui Android Studio project. You can use 'File->New->Import Module' option to easily include the source code to your project.

Usage

To read more about how to get started please see here and for details how to use this module here.

Download via Gradle

    compile 'net.donky:donky-module-rich-ui-inbox:2.8.0.0'

Initialise this module before initailising Donky Core in onCreate method of your application class.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
      
        DonkyRichInboxUI.initialiseDonkyRich(this,
      		new DonkyListener() /*set callback handlers*/);
      
		DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<", 
        	new DonkyListener() /*set callback handlers*/);
    		
	}
}

Open Inbox

Intent intent = new Intent(this, RichInboxAndMessageActivityWithToolbar.class);
startActivity(intent);

Donky-Analytics

The analytics module provides key metrics around app launches, app session times.

Source

You can find the source code of Donky Analytics in Donky/analytics Android Studio project. You can use 'File->New->Import Module' option to easily include the source code to your project.

Usage

To read more about how to get started please see here and for details how to use this module here.

Download via Gradle

    compile 'net.donky:donky-module-analytics:2.8.0.0'

Initialise this module before initailising Donky Core in onCreate method of your application class.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
      
        DonkyAnalytics.initialiseAnalytics(this,
        	new DonkyListener() /*set callback handlers*/);
      
		DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<", 
        	new DonkyListener() /*set callback handlers*/);
    		
	}
}

Donky-Automation

The automation layer adds the ability to invoke server defined behaviours.

Source

You can find the source code of Donky Automation in Donky/automation Android Studio project. You can use 'File->New->Import Module' option to easily include the source code to your project.

Usage

To read more about how to get started please see here and for details how to use this module here.

Download via Gradle

    compile 'net.donky:donky-module-automation:2.8.0.0'

Initialise this module before initailising Donky Core in onCreate method of your application class.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
      
        DonkyAutomation.initialiseDonkyAutomation(this, 
			new DonkyListener() /*set callback handlers*/);
      
		DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<", 
        	new DonkyListener() /*set callback handlers*/);
    		
	}
}

Donky-Assets

The automation layer adds the ability to invoke server defined behaviours.

Source

You can find the source code of Donky Automation in Donky/assets Android Studio project. You can use 'File->New->Import Module' option to easily include the source code to your project.

Usage

To read more about how to get started please see here and for details how to use this module here.

Download via Gradle

    compile 'net.donky:donky-module-automation:2.8.0.0'

Initialise this module before initailising Donky Core in onCreate method of your application class.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
      
        DonkyAssets.initialiseDonkyAssets(this, 
			new DonkyListener() /*set callback handlers*/);
      
		DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<", 
        	new DonkyListener() /*set callback handlers*/);
    		
	}
}

Donky-Location

The location module adds the ability to track device location locally, and communicate the information over the network to other devices or back to Donky for analytics

Source

You can find the source code of Donky Location in Donky/location Android Studio project. You can use 'File->New->Import Module' option to easily include the source code to your project.

Usage

To read more about how to get started please see here and for details how to use this module here.

Download via Gradle

    compile 'net.donky:donky-module-location:2.8.0.0'

Initialise this module before initailising Donky Core in onCreate method of your application class.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
      
        DonkyLocation.initialiseDonkyLocation(this, 
			new DonkyListener() /*set callback handlers*/);
      
		DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<", 
        	new DonkyListener() /*set callback handlers*/);
    		
	}
}

Donky-Sequencing

Use of this module allows you to perform multiple calls to some account controller methods without needing to implement call backs or worry about sequencing when changing local and network state.

Source

You can find the source code of Donky Core in Donky/sequencing Android Studio project. You can use 'File->New->Import Module' option to easily include the source code to your project.

Usage

To read more about how to get started please see here.

Download via Gradle

    compile 'net.donky:donky-module-sequencing:2.8.0.0'

Initialise this module before initailising Donky Core in onCreate method of your application class.

public class MyApplication extends Application {

    @Override
    public void onCreate()
    {
        super.onCreate();
		
        DonkySequencing.initialiseDonkySequencing(this, 
			new DonkyListener() /*set callback handlers*/);
      
		DonkyCore.initialiseDonkySDK(this,">>ENTER API KEY HERE<<", 
        	new DonkyListener() /*set callback handlers*/);
    		
	}
}

DonkySequenceAccountController class in this module overides the following methods

public void updateRegistrationDetails(UserDetails , DeviceDetails, DonkySequenceListener)

public void updateUserDetails(UserDetails , DonkySequenceListener)

public void updateDeviceDetails(DeviceDetails , DonkySequenceListener)

public void updateTags(List<TagDescription>, DonkySequenceListener)

public void setAdditionalProperties(TreeMap<String, String>, DonkySequenceListener)