quickverse/quickverse-android-sdk

The QuickVerse Android SDK

QuickVerse Android SDK

QuickVerse makes mobile & web app localization a breeze. Migrate your web and mobile localizations to QuickVerse Cloud, and start managing them anytime, anywhere, collaboratively.

1. Installation
2. Usage
   1. Import the SDK
   2. Configure the SDK
   3. Retrieve your QuickVerse localizations
   4. Access your localizations
3. Logging & Troubleshooting
4. FAQs
5. Support

Installation

Add the following dependency to your module-level build.gradle file:

dependencies {
    implementation 'io.quickverse.androidsdk:quickverse:1.5.7'
}

Usage

QuickVerse is a very lightweight integration, requiring just a few lines of code.

1. Import the SDK

import com.quickverse.androidsdk.QuickVerse

2. Configure the SDK on app launch

You'll need your APIKey, retrievable from your QuickVerse account here.

QuickVerse.configure(apiKey = "{your-api-key}", appPackageName = "{your-package-name}")
QuickVerse.isDebugEnabled = true // Optionally get detailed console logs

3. Retrieve your QuickVerse.io localizations

In most cases, you'll want to download the localizations during your launch sequence - before any copy is shown to the user.

QuickVerse.getLocalizations() { success ->
    // Continue into app or handle failure         
}

Note: Keep an eye on the console. If you enable isDebugEnabled, the QuickVerse SDK will print out all available keys from your quickverse.io account.

4. Access your localized strings

text = QuickVerse.stringFor("Onboarding.Demo.Title")

Optionally provide a default value, should the key not exist in the local store.

text = QuickVerse.stringFor("Onboarding.Demo.Title", "Welcome to QuickVerse")

Recommended: Although you can access the keys "inline", as showed above, we strongly recommend you store your keys in a single file for easy maintenance, e.g:

object QVKey {
    const val onboardingDemoTitle = "Onboarding.Demo.Title"
}

You can then access your localized strings without hardcoding keys:

text = QuickVerse.stringFor(QVKey.onboardingDemoTitle)

Logging & Troubleshooting

All QuickVerse console logs start with "QuickVerse: " for easy filtering. We recommend setting QuickVerse.isDebugEnabled = true during setup, and any time you're adding new keys.

Informational Logs:

• "Retrieving localizations for language code" - informs you which language localizations will be fetched for. Useful for testing.

Troubleshooting Logs:

• "API Key not configured" - have you called QuickVerse.configure(apiKey: "{your-api-key}") on app launch, before you try to fetch localizations?
• "API Key incorrect" - have you added your application to quickverse.io, and are you using the correct APIKey for the current Bundle ID? QuickVerse APIkeys are specific to bundle IDs.
• "No response received" / "Localizations empty" - have you added at least one localization to your quickverse.io account?

Missing logs? Make sure you're setting QuickVerse.isDebugEnabled = true when you configure the SDK.

FAQs

1. How big is your SDK? The final binary size of the QuickVerse iOS SDK is very small, just 0.01MB, or 10kb!
2. How does your SDK handle limited connectivity? Our SDK requests all localizations on launch and caches them, so if there's limited connectivity later in the session, the localizations will still work.
3. What kind of data does the SDK collect and how is it used? The only data our SDK transmits off the device is: language keys for translations, SDK version, and device type.
4. Can we request changes? Absolutely! Please share your requests with us at [email protected] and we'll review and get back to you.

Support

Got a query or need support? We're always on hand to help with your integration & beyond. Just ping us at [email protected] and we'll get back to you within your QuickVerse plan's SLA.