Giters

nbossard / orange-trust-badge-android

With Orange trust badge, or "Badge de confiance", give transparent information and user control on personal data and help users to identify if your application has any sensitive features.

Home Page:https://developer.orange.com/apis/trust/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

#Orange trust badge Android Reference

Orange trust badge : your privacy first

With the Orange trust badge, aka "Badge de confiance", give transparent information and user control on personal data and help users to identify if your application has any sensitive features.

Features

Orange trust badge displays how are handled the following data :

  • Identity of the User
  • Location
  • Photos, medias and files
  • Contacts
  • Usage data
  • Camera
  • Calendar
  • SMS
  • Microphone
  • Phone
  • Body sensors / Connected objects
  • Social Sharing
  • In-app purchase
  • Advertising

It also displays the following information :

  • Application's rating
  • Data usage general description
  • Help
  • Privacy policy

It also :

  • Works on Phones and Tablets with dedicated layout
  • Is Localized in 2 languages (English,French)
  • has API hooks
  • allows UI Customization
  • allows to embed a web hosted video with a native player

Requirements

  • Android 2.3.3 (API 10)
  • Embedded videos will be shown on android 4.0+ (API 14)

Bug tracker

If you find any bugs, please submit a bug report through Github and/or a pull request.

Example project

An example of integration is provided in OrangeTrustBadgeDemo project. You can download the last version of the demo app in the release page: https://github.com/Orange-OpenSource/orange-trust-badge-android/releases To run the example project, clone the repo, import it in Android Studio (versions above v1.0).

Installation

Embedded frameworks require a minSdkVersion of 10

1. Download the compiled library

To use the component in your own project, the fastest way is to download the latest aar release library in the release page: https://github.com/Orange-OpenSource/orange-trust-badge-android/releases You will then have to include the aar in the libs folder of your project

2. Update dependencies

Make sure to have the flatDir option for your libs folder in repositories

allprojects {
    repositories {
        mavenCentral()
        flatDir {
            dirs 'libs'
        }
    }
}

Add following dependency to the build.gradle file of the module that will use the Orange trust badge (adapt the name to the version you downloaded if necessary):

dependencies {
    //OTB
    compile(name: 'Orange_trust_badge-1.3.0-release', ext: 'aar')
    //android Support
    compile 'com.android.support:appcompat-v7:24.2.1'
    compile 'com.android.support:cardview-v7:24.2.1'
    compile 'com.android.support:recyclerview-v7:24.2.1'
}

3. Manage languages

The SDK includes default text in english and add a translation in french in the french localized directory values-fr. If you do not have french language in your app, and want to keep only engligh, exclude french resources using:

android {
    ...
    defaultConfig {
        ...
        resConfigs "en"
    }
}

If you want to use another language than english as default language, please provide translation in that language for all strings in the values/strings.xml file. Then build only the locales you support (overriding is necessary because the default is always kept in the package). For example, if I support Italian and Spanish, provide translation for one of the two as default language and than add this to your Gradle configuration file:

android {
    ...
    defaultConfig {
        ...
        resConfigs "it", "es"
    }
}

Alternative methods

You can also:

  • either directly copy, from the source code, the otb module in your project,
  • or import it as a new aar module using the Android Studio New Module menu.

In both cases you will have to add it to your dependencies as follow (supposing you named the new module otb):

dependencies {
    //android Support
    compile 'com.android.support:appcompat-v7:24.2.1'
    compile 'com.android.support:cardview-v7:24.2.1'
    compile 'com.android.support:recyclerview-v7:24.2.1'
    //OTB
    compile project(':otb') //if you named the new module `otb`
}

Usage

Initialization of the SDK

1. Create necessary elements (example)

Create a list of TrustBadgeElement and a list of Term. TrustBadgeElements can be easily created using the helper class TrustBadgeElementFactory, which provide convenient methods to create a badge.

    List<TrustBadgeElement> trustBadgeElements = new ArrayList<TrustBadgeElement>();
    /** MAIN BADGES - They Will appear on the main dashboard */
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.IDENTITY, ElementType.MAIN, AppUsesPermission.TRUE));
    
    //Define your own system app permission status
    //No scan for app permission is done in that case
    TrustBadgeElement elt = TrustBadgeElementFactory.build(mContext, GroupType.LOCATION, ElementType.MAIN);
    elt.setShouldBeAutoConfigured(false);
    elt.setAppUsesPermission(AppUsesPermission.TRUE);
    elt.setUserPermissionStatus(UserPermissionStatus.GRANTED);
    mTrustBadgeElements.add(elt);
    
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.STORAGE, ElementType.MAIN));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.CONTACTS, ElementType.MAIN));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.IMPROVEMENT_PROGRAM, ElementType.MAIN, AppUsesPermission.TRUE));
    //Custom Badge Element in MAIN Category
    TrustBadgeElement customBadge1 = TrustBadgeElementFactory.build(mContext, GroupType.OTHER, ElementType.MAIN, R.string.custom_badge_1_title,R.string.custom_badge_1_label);
    customBadge1.setEnabledIconId(R.drawable.ic_contacts_black_32dp);
    customBadge1.setDisabledIconId(R.drawable.ic_contacts_black_32dp);
    customBadge1.setToggable(true);
    customBadge1.setAppUsesPermission(AppUsesPermission.TRUE);
    customBadge1.setUserPermissionStatus(UserPermissionStatus.GRANTED);
    mTrustBadgeElements.add(customBadge1);

    /** OTHERS BADGES - They Will appear when entering More Data info*/
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.CAMERA, ElementType.OTHERS));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.AGENDA, ElementType.OTHERS));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.SMS, ElementType.OTHERS));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.MICROPHONE, ElementType.OTHERS));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.PHONE, ElementType.OTHERS));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.SENSORS, ElementType.OTHERS));
    //Custom Badge Element in OTHERS Category
    TrustBadgeElement customBadge2 = TrustBadgeElementFactory.build(mContext, GroupType.OTHER, ElementType.OTHERS, R.string.custom_badge_2_title,R.string.custom_badge_2_label);
    customBadge2.setEnabledIconId(R.drawable.ic_contacts_black_32dp);
    customBadge2.setDisabledIconId(R.drawable.ic_contacts_black_32dp);
    customBadge2.setToggable(true);
    customBadge2.setAppUsesPermission(AppUsesPermission.TRUE);
    customBadge2.setUserPermissionStatus(UserPermissionStatus.NOT_GRANTED);
    mTrustBadgeElements.add(customBadge2);


    /** USAGE BADGES */
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, RatingType.TWELVE));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.BILLING, ElementType.USAGE));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.ADVERTISE, ElementType.USAGE));
    trustBadgeElements.add(TrustBadgeElementFactory.build(mContext, GroupType.SOCIAL_INFO, ElementType.USAGE));

    /** Terms - You can add how many videos and terms section as you need */
    List<Term> terms = new ArrayList<Term>();
    //Provide your own terms if you want terms to be exposed
    terms.add(new Term(TermType.VIDEO, "Video Title" , "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4"));
    terms.add(new Term(TermType.TEXT, "Personal Data Usage Title", "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."));
    terms.add(new Term(TermType.TEXT, "Help Title", "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."));
    terms.add(new Term(TermType.TEXT, "More Info Title", "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."));

2. Initialize

Initialize TrustBadgeManager singleton with added items : a list of TrustBadgeElement and a list of Terms. Normally, on a standard implementation, you should also clean previous badge listeners.

    TrustBadgeManager.INSTANCE.initialize(getApplicationContext(), trustBadgeElements, terms);

3. Launch activity

Launch the main activity named OtbActivity to access to the TrustBadge component main UI.

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

Implementation of optional features

Custom badge element

Optionally you can have custom badge elements.

Add an element to your badge Elements List :

    /** How to create a custom badge and/or set it as a toggable */
    TrustBadgeElement customBadge = TrustBadgeElementFactory.build(mContext, GroupType.OTHER, ElementType.MAIN, R.string.custom_badge_2_title,R.string.custom_badge_2_label);
    customBadge.setEnabledIconId(R.drawable.otb_ic_contacts_black_32dp);
    customBadge.setDisabledIconId(R.drawable.otb_ic_contacts_black_32dp);
    customBadge.setToggable(true);
    customBadge.setAppUsesPermission(AppUsesPermission.TRUE);
    customBadge.setUserPermissionStatus(UserPermissionStatus.NOT_GRANTED);
    trustBadgeElements.add(customBadge);

When you initialize the badge, if you have added Toggle switches, provide initialization if you want persistent state. If you saved the value in the shared preferences:

    for (TrustBadgeElement element : TrustBadgeManager.INSTANCE.getTrustBadgeElements()) {
        //check if element is toggable and if is not improvement program (we managed it differently in our example)
        if (element.isToggable() && element.getGroupType() != GroupType.IMPROVEMENT_PROGRAM) {
            boolean granted = sp.getBoolean(element.getNameKey(), true);
            element.setUserPermissionStatus(granted?UserPermissionStatus.GRANTED:UserPermissionStatus.NOT_GRANTED);
        }
    }

Badge listener

Optionally provide a listener to listen to badges with toggles (such as improvement program). One BadgeListener is enough to listen for all the toggles in your implementation: By checking the element.getNameKey() and/or the element.getGroupType() you can have different behaviors.

  • NOTE: You need to make sure to do not have multiple copy of the same listener
    //We can add a badge listener. Make sure to do not have multiple copy of the same listener
    //You can also clear existing listener using: TrustBadgeManager.INSTANCE.clearBadgeListener();
    if (!TrustBadgeManager.INSTANCE.getBadgeListeners().contains(this)) {
        TrustBadgeManager.INSTANCE.addBadgeListener(this);
    }

    TrustBadgeManager.INSTANCE.addTrustBadgeElementListener(new TrustBadgeElementListener(){
        @Override
        public void onBadgeChange(GroupType groupType, boolean value, AppCompatActivity callingActivity) {
            //Do your own work : example, what to do if badge improvement program change
        }
    });

Please Note: addTrustBadgeElementListener has been deprecated in version G01R00C01 to allow managing custom toggable badges.

Improvement program

Optionally set a value defining if your app currently uses improvement program badge (default true, if value not provided)

    TrustBadgeManager.INSTANCE.setUsingImprovementProgram(isImprovementEnabled);

Prevent permission to be autoconfigured by system permission

Orange trust badge SDK configures automatically permission with the declaration made in manifest and user acceptation. If you want to bypass this behavior, you can set the "isShouldAutoConfigured" parameter of "TrustBadgeElement" to false.

TrustBadgeElement elt = TrustBadgeElementFactory.build(mContext, GroupType.LOCATION, ElementType.MAIN);
elt.setShouldBeAutoConfigured(false);
elt.setAppUsesPermission(AppUsesPermission.TRUE);
elt.setUserPermissionStatus(UserPermissionStatus.GRANTED);
mTrustBadgeElements.add(elt);

Customization

Customized colors (overloading file colors.xml)

Orange trust badge use colorAccent to for links, toggle and text as follows in a color resource file. The header background color can also be redefined. User can change this colors by editing the colors.xml resource file.

    <color name="colorAccent">#AA0000</color>
    <color name="otb_header_color">#00DD00</color>

Customized logo (overloading default drawable, file otb_header_logo.xml)

The header logo can be redefined by defining your own image. You should provide a drawable named otb_header_logo.xml. Please be aware that an incorrect image can lead to malformed header page.

    <?xml version="1.0" encoding="utf-8"?>
    <selector xmlns:android="http://schemas.android.com/apk/res/android">
        <item android:drawable="@drawable/otb_illustration_bleu"/>
    </selector>

Customized icons and labels

User should define its own labels and icon for the different badges, but default values are available to provide a decent app. Please be aware that string resources are localized, so overriding french values should be done in values-fr resource directory.

Customized otb activity theme

You can override the otb activity theme directly in your manifest (see demo app for an exemple)

In your manifest:

    <activity
        android:name="com.orange.essentials.otb.OtbActivity"
        android:configChanges="orientation|screenSize"
        android:theme="@style/AppTheme.MyOtbTheme"
        tools:replace="android:theme" />

Then, in your styles.xml file you can for exemple override the toolbar colors by overriding primary and primaryDark color:

    <style name="AppTheme.MyOtbTheme" parent="Theme.AppCompat.Light.DarkActionBar">
        <item name="colorPrimary">@color/otb_black</item>
        <item name="colorPrimaryDark">@color/otb_black</item>
    </style>

Release note

Version 1.0

License

Copyright (C) 2016 Orange

This software is distributed under the terms and conditions of the 'Apache-2.0' license which can be found in the file 'License.txt' in this package distribution or at

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

Third-Party Code

This software includes the following third-party code:

AOSP

Copyright (C) 2006 The Android Open Source Project

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.

Contacts

BOESCH Vincent, vincent.boesch@orange.com PENAULT Aurore, aurore.penault@orange.com ACCETTA Giovanni Battista, giovannibattista.accetta@orange.com

About

With Orange trust badge, or "Badge de confiance", give transparent information and user control on personal data and help users to identify if your application has any sensitive features.

https://developer.orange.com/apis/trust/

License:Apache License 2.0

Languages

Language:Java 100.0%