Repository files navigation

Publish your translations faster and simpler than ever before. Stop waiting for the next deployment and start publishing all your translations in real-time directly in Phrase.

For more details on how OTA works head over to the Phrase Help Center:https://support.phrase.com/hc/en-us/articles/5804059067804-Over-the-Air-Strings

With the SDK, the app regularly checks for updated translations and downloads them in the background. Translations are fetched whenupdateTranslations is called, which should usually happen inonCreate.

• The SDK requires at least appcompat version 1.2.0. If using an older version of appcompat, consider using SDK version2.1.3
• The library depends on AndroidX to support backward compatible UI elements such as the toolbar.

Add a new repository to the rootbuild.gradle:

allprojects {    repositories {        ...        maven { url "https://maven.download.phrase.com" }    }}

Add the library as a dependency:

dependencies {    implementation "com.phrase.android:ota-sdk:3.10.2"    ...}

To enable Jetpack Compose support for OTA translations, follow these steps:

1. Add the libraryimplementation "com.phrase.android:ota-sdk-compose:3.10.2" to the root build.gradle.
2. Wrap the Jetpack Compose code inPhrase { ... }.

Initialize the SDK in the application class and add the distribution ID and environment secret. Classes inheriting from Application should overwriteattachBaseContext to enable translations outside of the activity context:

publicclassMainApplicationextendsApplication {@OverridepublicvoidonCreate() {super.onCreate();Phrase.setup(this,"DISTRIBUTION_ID","ENVIRONMENT_TOKEN");Phrase.updateTranslations();  }@OverrideprotectedvoidattachBaseContext(ContextnewBase) {super.attachBaseContext(Phrase.wrapApplicationContext(newBase));  }}

Iinject the SDK in each activity, e.g. by creating a base activity which all other activities inherit from:

publicclassBaseActivityextendsAppCompatActivity {@NonNull@OverridepublicAppCompatDelegategetDelegate() {returnPhrase.getDelegate(this,super.getDelegate());  }}

Translations can be used as usual in layouts:

<TextViewandroid:text="@string/translation_key" />

And inside code:

TextViewtext = (TextView)findViewById(R.id.text_id);text.setText(R.string.translation_key);

Some libraries do not support automatically unwrapping the context and expect a specific class. In this case context wrapping in Jetpack Compose components can be disabled with:

Phrase(contextWrapping = false) {    Text( text = phraseString(R.string.test) )}

Java

PhraseLog.setLogLevel(Severity.Debug);

Kotlin

PhraseLog.logLevel=Severity.Verbose

Other supported logging values:None,Error,Warning,Info,Debug,Verbose

The SDK uses the app version by default to return a release which matches the release constraints for the min and max version. The app version must use semantic versioning otherwise no translation update is returned. In case the app does not use semantic versioning it is possible to manually override the used app version.

Example:Phrase.setAppVersion("3.2.4");The version must be set before callingupdateTranslations().

The default timeout for translation downloads is set to 10s. The default can be changed with:

// Timeout in millisecondsPhrase.setTimeout(10000);

If the handling of successful translation updates is required, attach a callback handler:

Phrase.updateTranslations(newTranslationsSyncCallback() {@OverridepublicvoidonSuccess(booleantranslationsChanged) {    }@OverridepublicvoidonFailure() {    }});

Translation updates can also be triggered manually. Newly fetched translations are displayed upon the next application launch.

To make the latest translations immediately available, use the methodPhrase.applyPendingUpdates(). This can be combined with listening for translation updates:

Phrase.updateTranslations(newTranslationsSyncCallback() {@OverridepublicvoidonSuccess(booleantranslationsChanged) {if(translationsChanged) {Phrase.applyPendingUpdates()// Custom logic to refresh UI      }    }@OverridepublicvoidonFailure() {    }});

The UI does not display translations automatically and must be recreated.

Phrase US data center is also supported. The US data center can be configured by calling:

Phrase.setHost("https://ota.us.phrase.com/")

In case it is not possible to reach Phrase due to a missing network connection of the client or a service interruption, the SDK uses the bundled translations from the resource file. The regular updating of the bundled translations in the app is recommended. The SDK also caches translations locally on the device. If such a cache exists, it is used until the next translation update.

The SDK uses the most recent release for the translations. In case the versionName for the app is set, the most recent release that satisfies the version restrictions will be used.

Creating the new language in Phrase and create a new release. The SDK fetches the language when this is the device language of a user. Regularly adding a new strings.xml for new languages files when releasing a new app version is recommended or users will only see the fallback translations determined by Android at the first start of the app.

The SDK is closed source and can not be viewed or modified. If it is an organization requirement, audits can be provided. Contact us for more details if required.

Custom views can be translated using styled attributes. Since TypedArray does not allow overwriting the resources, slight changes in the custom view are required:

Before:

context.obtainStyledAttributes(attrs,R.styleable.CustomView, defStyleAttr,0).use {    text= it.getText(R.styleable.CustomView_android_text)}

After:

context.obtainStyledAttributes(attrs,R.styleable.CustomView, defStyleAttr,0).use {    text= it.getTextWithPhrase(R.styleable.CustomView_android_text)}

Before:

finalTypedArrayta =context.obtainStyledAttributes(attrs,R.styleable.CustomView,defStyleAttr,0);try {setText(ta.getText(R.styleable.CustomView_android_text));}finally {ta.recycle();}

After:

finalTypedArrayta =context.obtainStyledAttributes(attrs,R.styleable.CustomView,defStyleAttr,0);try {setText(PhraseTypedArray.getTextWithPhrase(ta,R.styleable.CustomView_android_text));}finally {ta.recycle();}

Exampleapp

If translations are not being updated

• Ensure distribution id and environment secret are correct.
• Ensure a release was created on for the current app version.
• Reload the ViewController to make changes appear immediately.

If the wrong version of a translation is being used, ensure a release with the latest translations and the current app version is available and theversionName for the app set and are using the<major>.<minor>.<point>. format.

• Inflated menus and preferences are not supported yet
• Some libraries that do not support automatic context unwrapping can cause issues. For exampleHilt requires to disable automatic context wrapping in Compose componentshttps://github.com/phrase/phrase-android/releases/tag/3.5.0