Onboarding Customization¶
Use the OnboardingCustomizations property to customize the strings used in the Onboarding flow pages such as EULA screen, passcode setup screen, and bio-metric enabling screen. If you do not define these, then the default strings that have been localized to multiple languages are used.
You should only set these properties if you intend to customize them. If you customize these properties, you need to provide your own localization of the custom strings.
You can find this option in the MDKClient_SDK/template.mdkproject/BrandedSettings.json file.
Example:
Use localization API (recommended):
"OnboardingCustomizations": {
"eulaTitleString": "$(L,my_eula_title)",
"agreeButtonString": "$(L,my_eula_agree_btn)",
"disagreeButtonString": "$(L,my_eula_disagree_btn)"
}
Or use literal string:
"OnboardingCustomizations": {
"authenticationFailedMessageString": "Wrong credential, please try again. Please contact abc@xyz.com if you need a new account"
}
Include Internalization Properties Files in Your Branded Client¶
In order to provide i18n properties files, you must provide built-in metadata in your branded client. Here is how you can provide built-in metadata with i18n properties files:
- Option 1
Export you main app project from Mobile Development Kit editor and place it under <.mdkproject directory>/metadata as built-in metadata.
- Option 2
If you do not wish to place your main app as built-in metadata in the branded client, you can create an MDK Empty Project and copy all of your i18n properties files from the main project to this empty project. You can then export it from Mobile Development Kit editor and place it under <.mdkproject directory>/metadata as built-in metadata.
Note: This empty app will now become the app that run when user onboard to your branded client for the first time. You can design it to look better with landing page if you wish to.
For more details about Internalization, please see Internationalization and Localization of App Metadata.
The following table is the list of properties of that can be set to customize the text in Onboarding flow.
| Key | Default String | Supported Platform |
|---|---|---|
eulaTitleString |
End User License Agreement | iOS, Android |
agreeButtonString |
Agree | iOS, Android |
disagreeButtonString |
Disagree | iOS, Android |
Android:
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
eulaRejectAlertTitleText |
Without consent, you will not be able to continue onboarding. | iOS only |
eulaRejectAlertQuitBtnText |
Quit Process | iOS only |
eulaRejectAlertConsentBtnText |
Give Consent | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
scanButtonString |
Scan | iOS, Android |
Android:
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
networkUnreachableFailureString |
Network unreachable. Please try again later. | iOS only |
retryButtonString |
Retry | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
invalidConnectionTitle |
Invalid Connection | iOS only |
invalidConnectionMessage |
The connection settings contains URL that is not in allowed domains | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
selectOptionString |
Please select an option | iOS, Android |
continueWithSameAppString |
Use current application | iOS, Android |
scanNewQRCodeString |
Scan new QR code | iOS, Android |
Android:
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
authenticationFailedMessageString |
Failed to onboard! | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
choosePasscodeTitleString |
Choose Passcode (iOS) Create Passcode (Android) |
iOS, Android |
setPasscodeMessageFormat |
Choose a passcode with at least %d characters for unlocking the app. (iOS) Please set a passcode that satisfies the guidelines listed below. (Android) |
iOS, Android |
includeRequiredGroupMessage |
Include the following: | iOS only |
lowerCaseLabelString |
Lower case (a-z) | iOS only |
upperCaseLabelString |
Upper case (A-Z) | iOS only |
digitsLabelString |
Digits (0-9) | iOS only |
nonAlphabeticLabelString |
Symbols (!@#...) | iOS only |
nextItemString |
Next | iOS, Android |
Android:
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
confirmPasscodeTitleString |
Confirm Passcode (iOS) Verify Passcode (Android) |
iOS, Android |
enterPasscodeAgainString |
Enter your passcode again | iOS only |
confirmPasscodeString |
Confirm the passcode you created. | Android only |
Android:
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
passcodeNotMatchMessageString |
Passcodes did not match. Try again. | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
faceIDTitleString |
Face ID | iOS only |
faceIDMessage1String |
Enabling Face ID will give you faster access to your information. | iOS only |
faceIDMessage2String |
You can turn this feature on or off at anytime from Settings. | iOS only |
notNowButtonString |
Not Now | iOS only |
enableButtonString |
Enable | iOS only |
learnMoreFaceIDLinkString |
Learn more about Face ID | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
touchIDTitleString |
Touch ID | iOS only |
touchIDMessage1String |
Enabling Touch ID will give you faster access to your information. | iOS only |
touchIDMessage2String |
You can turn this feature on or off at anytime from Settings. | iOS only |
learnMoreTouchIDLinkString |
Learn more about Touch ID | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
authenticateWithFaceIDMessageString |
Authenticate with Face ID | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
authenticateWithTouchIDMessageString |
Authenticate with Touch ID | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
passcodeTitleString |
Passcode | iOS, Android |
enterYourPasscodeMessageString |
Enter your passcode | iOS only |
attemptsLeftMessageFormat |
You have %d attempts left. | iOS only |
resetPasscodeButtonString |
Reset Client | iOS only |
resetClientButtonString |
Reset Client | Android only |
Android:
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
oneAttempLeftMessageFormat |
You have 1 attempt left. | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
changePasscodeTitleString |
Change Passcode | iOS only |
enterYourCurrentPasscodeMessageString |
Enter your current passcode. | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
maxAttemptsReachedMessageString |
No more attempts left | iOS only |
enterCredentialsMessageString |
Please start the onboarding process again! | iOS only |
okButtonString |
Ok | iOS only |
iOS:
| Key | Default String | Supported Platform |
|---|---|---|
switchUserButtonLabelString |
Switch or Add User | iOS only |
iOS:
