RooftopDigitsUtils-Android

A library that gives you access to the Rooftop cloud platform from your Android app with Digits authorisation. For more information about Rooftop and its features, see the website and getting started.

Download

To download SDK with gradle use the next tips.

Step 1:

Set the url to download the sdk in top-level (project-level) build.gradle file

allprojects {
  repositories {
    ***
    maven { url 'https://raw.githubusercontent.com/Rooftoptek/Rooftop-SDK-Android/<release name>/releases/' }
    maven { url 'https://raw.githubusercontent.com/Rooftoptek/RooftopDigitsUtils-Android/<release name>/releases/' }
    maven { url 'https://maven.fabric.io/public' }
}

Url example for release 0.5.0:

maven { url 'https://raw.githubusercontent.com/Rooftoptek/RooftopDigitsUtils-Android/0.5.0/releases/' }

Step 2:

Set the dependency of the "RooftopDigitsUtils" in the build.gradle file of the main module

dependencies {
  ***
  compile(group: 'io.rftp', name: 'rooftopdigitsutils', version: '<release name>')
}

Initialisation

To initialize SDK use the next tips.

Step 1:

Set android minSdkVersion not less than 15

Step 2:

Configure AndroidManifest.xml file of the main project:

A. Set the permissions:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

B. Set rooftop credentials like meta-data in "application" section.

B0. Modify AndroidManifest.xml:

<application
***>
***
  <meta-data
    android:name="io.rftp.APPLICATION_ID"
    android:value="@string/rooftop_app_id" />
  <meta-data
    android:name="io.rftp.IDENTITY_POOL_ID"
    android:value="@string/rooftop_identity_pool_id" />
  <meta-data
    android:name="io.rftp.CLIENT_KEY"
    android:value="@string/rooftop_client_key" />
  <meta-data
    android:name="com.twitter.sdk.ConsumerKey"
    android:value="@string/twitter_app_key"/>
  <meta-data
    android:name="com.twitter.sdk.ConsumerSecret"
    android:value="@string/twitter_app_secret"/>
  <meta-data
    android:name="io.fabric.ApiKey"
    android:value="@string/fabric_api_key"/>
</application>

B1. Put your credentials in strings.xml:

<resources>
  ***
  <string name="rooftop_app_id">xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</string>
  <string name="rooftop_identity_pool_id">xx-xxxx-x:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</string>
  <string name="rooftop_client_key">xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</string>
  <string name="twitter_app_key">xxxxxxxxxxxxxxxxxxxxxxxxx</string>
  <string name="twitter_app_secret">xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</string>
  <string name="fabric_api_key">xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</string>
</resources>

Step 3:

Call Rooftop.initialize() and RooftopDigits.initialize() in onCreate(*) method of the Application class of the project

public class MyApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();
    ***
    Rooftop.initialize(this);
    RooftopDigitsUtils.initialize(this);
  }
}

If you don't have your own Application class, create one. Specify usage of your MyApplication class in AndroidManifest-file:

<application
  ***
  android:name=".MyApplication">
    ***
</application>

Basic API calls

Login with Digits

Call corresponding login method from RooftopDigitsUtils SDK

RooftopDigitsUtils.logIn(RTLogInCallback callback);

Logout with Digits

Digits.logout();

For more information about Basic Rooftop API calls, see the website and getting started.

License

Copyright (c) 2016-present, RFTP Technologies Ltd.
All rights reserved.