Welcome to Instabug's Documentation!
Here you'll find a comprehensive technical guide
to help you start working with the Instabug SDK efficiently.

Get Started

SDK Locale

This section covers how to change the language of the SDK in your app as well as the content of all Instabug messages that your users see.

Setting the Locale

The SDK will automatically use the current locale of your user's device, however, you can override it with the following method.

Instabug.setLocale(new Locale("de"));

Here are the possible languages.

new Locale("en");
new Locale("fr");
new Locale("de");
new Locale("it");
new Locale("ja");
new Locale("ko");
new Locale("zh");
new Locale("zh", "CN");
new Locale("zh", "TW");
new Locale("ar");
new Locale("cs");
new Locale("da");
new Locale("es");
new Locale("fa");
new Locale("in");
new Locale("nl");
new Locale("pl");
new Locale("pt");
new Locale("ru");
new Locale("sk");
new Locale("sv");
new Locale("tr");

Dashboard Language

At the moment, the Instabug dashboard only supports English. Changing the SDK locale will not change the language of your dashboard.

Overriding String Values

You can also override each string shown in the SDK individually using the following method.

InstabugCustomTextPlaceHolder placeHolder = new InstabugCustomTextPlaceHolder();
placeHolder.set(REPORT_FEEDBACK, "Send Feedback");
Instabug.setCustomTextPlaceHolders(placeHolder);

Here are the possible keys.

SHAKE_HINT
SWIPE_HINT
INVALID_EMAIL_MESSAGE
INVALID_COMMENT_MESSAGE
INVOCATION_HEADER
START_CHATS
REPORT_BUG
REPORT_FEEDBACK
EMAIL_FIELD_HINT
COMMENT_FIELD_HINT_FOR_BUG_REPORT
COMMENT_FIELD_HINT_FOR_FEEDBACK
ADD_VOICE_MESSAGE
ADD_IMAGE_FROM_GALLERY
ADD_EXTRA_SCREENSHOT
CONVERSATIONS_LIST_TITLE
AUDIO_RECORDING_PERMISSION_DENIED
CONVERSATION_TEXT_FIELD_HINT
BUG_REPORT_HEADER
FEEDBACK_REPORT_HEADER
VOICE_MESSAGE_PRESS_AND_HOLD_TO_RECORD
VOICE_MESSAGE_RELEASE_TO_ATTACH
REPORT_SUCCESSFULLY_SENT
SUCCESS_DIALOG_HEADER
ADD_VIDEO
VIDEO_PLAYER_TITLE
FEATURES_REQUEST
FEATURES_REQUEST_ADD_FEATURE_TOAST
FEATURES_REQUEST_ADD_FEATURE_THANKS_MESSAGE
SURVEYS_WELCOME_SCREEN_TITLE
SURVEYS_WELCOME_SCREEN_SUBTITLE
SURVEYS_WELCOME_SCREEN_BUTTON
INSTABUG_CUSTOM_SURVEY_THANKS_TITLE
INSTABUG_CUSTOM_SURVEY_THANKS_SUBTITLE
BETA_WELCOME_MESSAGE_WELCOME_STEP_TITLE
BETA_WELCOME_MESSAGE_WELCOME_STEP_CONTENT
BETA_WELCOME_MESSAGE_HOW_TO_REPORT_STEP_TITLE
BETA_WELCOME_MESSAGE_HOW_TO_REPORT_STEP_CONTENT
BETA_WELCOME_MESSAGE_FINISH_STEP_TITLE
BETA_WELCOME_MESSAGE_FINISH_STEP_CONTENT
LIVE_WELCOME_MESSAGE_TITLE
LIVE_WELCOME_MESSAGE_CONTENT

What's Next

The locale is reflected in all aspects of the Instabug SDK that your users see in your app, including the Welcome Message, bug reporting flow, and Prompt Options.

Welcome Message
Bug Reporting
Prompt Options

SDK Locale


This section covers how to change the language of the SDK in your app as well as the content of all Instabug messages that your users see.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.