Skip to content

transcend-io/consent-manager-android-sample-sdk

Repository files navigation

consent-manager-android-sample-sdk

This repository showcases a sample Android application that consumes Transcend's WebView library.

Local setup required for sampleSDK

  • Android Studio
  • Gradle8.0
  • jbr17.0.8

Build and Install sampleSDK Application

  1. ./gradlew androidDependencies
  2. ./gradlew assemble
  3. ./gradlew build
  4. adb -d install ./app/build/outputs/apk/release/app-release-unsigned.apk or click play button on your android studio.

Usage of WebView Library in Sample Application:

Step 1: Add Dependencies

  • Add the following dependencies on you app modules build.gradle file and install the following android dependencies:
// STEP 1: Add required dependencies
implementation 'io.transcend.webview:webview:1.0.0-SNAPSHOT'
implementation 'androidx.webkit:webkit:1.7.0'

Step 2: Add Dependencies

  • Add the following repository on dependencyResolutionManagement in settings.gradle file
// STEP 2: Add following repository
maven {
 url= "https://s01.oss.sonatype.org/content/repositories/snapshots/"
}

Step 3: Use the custom Transcend WebView

  • Application developers using our custom WebView have the flexibility to employ this view in various contexts based on their application's logic. They can integrate this view during their application's startup, within the main activity, or in response to a button click event. To use Transcend’s webView the following changes are required:
<RelativeLayout
    xmlns:app="http://schemas.android.com/apk/res-auto"
    ...
    ...>
	<!-- on activity_main.xml -->
	<io.transcend.webview.TranscendWebView
	        android:id="@+id/webView"
	        android:layout_width="match_parent"
	        android:layout_height="match_parent"
	        android:visibility="visible"
		app:transcendConsentUrl= "@string/transcendConsentUrl"/>
</RelativeLayout>
  • Note - Users would need to create: reference
<!-- create a new value for transcendConsentUrl on res/values/strings.xml and configure it with your airgap url-->
<resources>
    <string name="transcendConsentUrl">https://cdn.transcend.io/cm/{ai}/airgap.js</string>
</resources>
// Add the following import
import io.transcend.webview.TranscendWebView;

public class MainActivity extends AppCompatActivity {
	private TranscendWebView webView;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
	//Step 3: Get the webViewbyId and use loadUrl() to show up TCF-UI
	// Note: on close of TCF-UI the visibilty of this view is set to GONE
        webView = (TranscendWebView) findViewById(R.id.webView);
	// the line below wouldn't be required in future releases
        webView.loadUrl("https://appassets.androidplatform.net/assets/index.html");
				
    }
}