Prerequisites

Minimum Platform Requirements

Android

• Android API level 23 (M) or above
• Gradle 8+
• Kotlin 1.9.0 / Java 17

iOS

• Xcode 13.2 or above
• Project with iOS 13 or above

Campaign Setup

Before starting SDK integration ensure you have a client campaign ID and a username and password to access our artefact repository. Please contact Tappa to:

1. Get your CampaignID (without it you will not be able to use the framework)
2. Get access to our artefact distribution repositories:
   • this can be a package repository containing the SDK framework
   • or in the case of React Native a RN module repo

Onboarding

Android

Before the user can use the keyboard, they must set the keyboard as default from the system settings. We recommend using onboarding steps to make sure most users enable & set the keyboard as default.

iOS

Before the user can use the Keyboard, they must activate the Keyboard in iOS Settings. We use the onboarding steps to make sure most users activate the Keyboard and start using it.

Onboarding is a part of KeyboardSDK and is explained in this document. The SDK client will be able to customise text, colours, and the Onboarding Selling the Benefits slides. Please refer to section: 

Customisation

Search Index and Local Database

In addition to a world-class keyboard, the SDK also has capabilities that include content recommendation and monetization. All of this is provided from a search engine and local database containing content like suggestions/gifs/stickers for both performance and privacy. When the user types, its recommendations are determined from the search index and provided from the local database. The first time you launch the SDK, and periodically afterward, the SDK performs a synchronization routine to ensure that the database and search index are updated with the latest content. This scheduled synchronization happens in the background and is optimized to ensure the minimum of bandwidth is used.

🚧

Launching the SDK in Android

Please note that only when SDK is launched from the main app can it schedule background jobs.

Supporting Infrastructure

No additional supporting infrastructure is required. The Cashback Keyboard SDK automatically communicates with the Tappa server periodically for analytics & retrieving the latest content such as gifs, stickers and brands.