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 as well as the content of all the messages that your users will see.

Setting the Locale

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

//iOS
Instabug.SetLocale(IBGLocale.English);

//Android
new Instabug.Builder(this, "YOUR_ANDROID_TOKEN")
            .SetInvocationEvent(InstabugInvocationEvent.Shake)
            .SetLocale(Locale.French)
                        .Build();

Here are the possible locale values.

//iOS
IBGLocale.Arabic,
IBGLocale.ChineseSimplified
IBGLocale.ChineseTaiwan
IBGLocale.ChineseTraditional
IBGLocale.Czech
IBGLocale.Danish
IBGLocale.English
IBGLocale.French
IBGLocale.German
IBGLocale.Italian
IBGLocale.Japanese
IBGLocale.Korean
IBGLocale.Norwegian
IBGLocale.Polish
IBGLocale.Portugese
IBGLocale.PortugueseBrazil
IBGLocale.Russian
IBGLocale.Slovak
IBGLocale.Spanish
IBGLocale.Swedish
IBGLocale.Turkish

//Android
Locale.Arabic
Locale.ChineseSimplified
Locale.ChineseTraditional
Locale.Czech
Locale.Danish
Locale.English
Locale.French
Locale.German
Locale.Italian
Locale.Japanese
Locale.Polish
Locale.PortugueseBrazil
Locale.Russian
Locale.Spanish
Locale.Swedish
Locale.Turkish

📘

Dashboard Language

At the moment, the Instabug dashboard only supports English. Changing the SDK locale will not have an impact on the dashboard.

String Values

You can also override each string shown in the SDK individually to provide your own localization.

//iOS
Instabug.SetValue("Report a bug", IBGString.ReportBug);

//Android
InstabugCustomTextPlaceHolder placeHolder = new InstabugCustomTextPlaceHolder();
placeHolder.Set(InstabugCustomTextPlaceHolder.Key.ReportBug, "Report a new bug");
Instabug.SetCustomTextPlaceHolders(placeHolder);

Here are the possible key values.

// iOS
// iOS
IBGStringKey.IBGActualResultsStringName
IBGStringKey.IBGAddAttachmentButtonTitleStringName
IBGStringKey.IBGAddExtraScreenshotStringName
IBGStringKey.IBGAddImageFromGalleryStringName
IBGStringKey.IBGAddNewFeatureRequestCancelPromptTitle
IBGStringKey.IBGAddNewFeatureRequestCancelPromptYesAction
IBGStringKey.IBGAddNewFeatureRequestErrorToastText
IBGStringKey.IBGAddNewFeatureRequestLoadingHUDTitle
IBGStringKey.IBGAddNewFeatureRequestSuccessHUDMessage
IBGStringKey.IBGAddNewFeatureRequestSuccessHUDTitle
IBGStringKey.IBGAddNewFeatureRequestText
IBGStringKey.IBGAddNewFeatureRequestToastText
IBGStringKey.IBGAddNewFeatureRequestTryAgainText
IBGStringKey.IBGAddScreenRecordingMessageStringName
IBGStringKey.IBGAddVoiceMessageStringName
IBGStringKey.IBGAskAQuestionStringName
IBGStringKey.IBGAudioRecordingPermissionDeniedMessageStringName
IBGStringKey.IBGAudioRecordingPermissionDeniedTitleStringName
IBGStringKey.IBGAudioStringName
IBGStringKey.IBGBetaWelcomeDoneButtonTitle
IBGStringKey.IBGBetaWelcomeMessageFinishStepContent
IBGStringKey.IBGBetaWelcomeMessageFinishStepTitle
IBGStringKey.IBGBetaWelcomeMessageHowToReportStepContent
IBGStringKey.IBGBetaWelcomeMessageHowToReportStepTitle
IBGStringKey.IBGBetaWelcomeMessageWelcomeStepContent
IBGStringKey.IBGBetaWelcomeMessageWelcomeStepTitle
IBGStringKey.IBGCancelButtonTitleStringName
IBGStringKey.IBGChatReplyFieldPlaceholderStringName
IBGStringKey.IBGChatsTitleStringName
IBGStringKey.IBGCollectingDataText
IBGStringKey.IBGCommentFieldPlaceholderForBugReportStringName
IBGStringKey.IBGCommentFieldPlaceholderForFeedbackStringName
IBGStringKey.IBGCommentFieldPlaceholderForQuestionStringName
IBGStringKey.IBGCustomSurveyThankYouDescriptionText
IBGStringKey.IBGCustomSurveyThankYouTitleText
IBGStringKey.IBGDescriptionText
IBGStringKey.IBGDiscardAlertAction
IBGStringKey.IBGDiscardAlertCancel
IBGStringKey.IBGDiscardAlertMessage
IBGStringKey.IBGDiscardAlertTitle
IBGStringKey.IBGDismissButtonTitleStringName
IBGStringKey.IBGEdgeSwipeStartAlertTextStringName
IBGStringKey.IBGEmailFieldPlaceholderStringName
IBGStringKey.IBGEmailRequiredText
IBGStringKey.IBGEmailText
IBGStringKey.IBGExpectedResultsStringName
IBGStringKey.IBGExtraFieldIsRequiredText
IBGStringKey.IBGExtraFieldMissingDataText
IBGStringKey.IBGFeatureDetailsTitle
IBGStringKey.IBGFeatureRequestAddButtonText
IBGStringKey.IBGFeatureRequestAddYourIdeaText
IBGStringKey.IBGFeatureRequestAddYourThoughtsText
IBGStringKey.IBGFeatureRequestAnonymousText
IBGStringKey.IBGFeatureRequestAuthorText
IBGStringKey.IBGFeatureRequestCommentsText
IBGStringKey.IBGFeatureRequestEmptyViewTitle
IBGStringKey.IBGFeatureRequestErrorStateDescriptionLabel
IBGStringKey.IBGFeatureRequestErrorStateTitleLabel
IBGStringKey.IBGFeatureRequestInvalidEmailText
IBGStringKey.IBGFeatureRequestPostButtonText
IBGStringKey.IBGFeatureRequestSortingByRecentlyUpdatedText
IBGStringKey.IBGFeatureRequestSortingByTopVotesText
IBGStringKey.IBGFeatureRequestStatusChangeText
IBGStringKey.IBGFeatureRequestStatusCompleted
IBGStringKey.IBGFeatureRequestStatusLessText
IBGStringKey.IBGFeatureRequestStatusMaybeLater
IBGStringKey.IBGFeatureRequestStatusMoreText
IBGStringKey.IBGFeatureRequestStatusPlanned
IBGStringKey.IBGFeatureRequestStatusPosted
IBGStringKey.IBGFeatureRequestStatusStarted
IBGStringKey.IBGFeatureRequestTimelineEmptyText
IBGStringKey.IBGFeatureRequestTimelineErrorDescriptionLabel
IBGStringKey.IBGFeatureRequestVoteText
IBGStringKey.IBGFeatureRequestVoteWithCountText
IBGStringKey.IBGFeatureRequestsTitle
IBGStringKey.IBGFeatureRequetsPromptName
IBGStringKey.IBGFloatingButtonStartAlertTextStringName
IBGStringKey.IBGGalleryPermissionDeniedAlertMessage
IBGStringKey.IBGGalleryPermissionDeniedAlertTitle
IBGStringKey.IBGImageStringName
IBGStringKey.IBGInboundByLineMessage
IBGStringKey.IBGInvalidCommentMessageStringName
IBGStringKey.IBGInvalidCommentTitleStringName
IBGStringKey.IBGInvalidEmailMessageStringName
IBGStringKey.IBGInvalidEmailTitleStringName
IBGStringKey.IBGInvocationTitleStringName
IBGStringKey.IBGLiveWelcomeMessageContent
IBGStringKey.IBGLiveWelcomeMessageTitle
IBGStringKey.IBGLowDiskStorageMessage
IBGStringKey.IBGLowDiskStorageTitle
IBGStringKey.IBGMaximumSizeExceededAlertMessage
IBGStringKey.IBGMaximumSizeExceededAlertTitle
IBGStringKey.IBGMessagesNotificationTitleMultipleMessagesStringName
IBGStringKey.IBGMessagesNotificationTitleSingleMessageStringName
IBGStringKey.IBGMicrophonePermissionAlertLaterButtonTitleStringName
IBGStringKey.IBGMicrophonePermissionAlertSettingsButtonTitleStringName
IBGStringKey.IBGNameText
IBGStringKey.IBGOkButtonTitleStringName
IBGStringKey.IBGPhotoPickerTitle
IBGStringKey.IBGProgressViewTitle
IBGStringKey.IBGReachedMaximimNumberOfAttachmentsMessageStringName
IBGStringKey.IBGReachedMaximimNumberOfAttachmentsTitleStringName
IBGStringKey.IBGRecordingMessageToHoldTextStringName
IBGStringKey.IBGRecordingMessageToReleaseTextStringName
IBGStringKey.IBGReplyButtonTitleStringName
IBGStringKey.IBGReportBugStringName
IBGStringKey.IBGReportFeedbackStringName
IBGStringKey.IBGScreenRecordingPermissionDeniedMessageStringName
IBGStringKey.IBGScreenRecordingStringName
IBGStringKey.IBGScreenshotStartAlertTextStringName
IBGStringKey.IBGScreenshotTitleStringName
IBGStringKey.IBGSendButtonTitleStringName
IBGStringKey.IBGShakeStartAlertTextStringName
IBGStringKey.IBGStartAlertTextStringName
IBGStringKey.IBGStepsToReproduceStringName
IBGStringKey.IBGStoreRatingThankYouDescriptionText
IBGStringKey.IBGStoreRatingThankYouTitleText
IBGStringKey.IBGStringFeatureRequestAllFeaturesText
IBGStringKey.IBGStringFeatureRequestMyFeaturesText
IBGStringKey.IBGStringFeatureRequestsRefreshText
IBGStringKey.IBGSurveyAppStoreButtonTitle
IBGStringKey.IBGSurveyAppStoreThankYouTitle
IBGStringKey.IBGSurveyEnterYourAnswerTextPlaceholder
IBGStringKey.IBGSurveyIntroDescriptionText
IBGStringKey.IBGSurveyIntroTakeSurveyButtonText
IBGStringKey.IBGSurveyIntroTitleText
IBGStringKey.IBGSurveyNextButtonTitle
IBGStringKey.IBGSurveySubmitButtonTitle
IBGStringKey.IBGSurveyThankYouDescriptionText
IBGStringKey.IBGSurveyThankYouTitleText
IBGStringKey.IBGSurveysNPSLeastLikelyStringName
IBGStringKey.IBGSurveysNPSMostLikelyStringName
IBGStringKey.IBGTeamStringName
IBGStringKey.IBGThankYouAlertMessageStringName
IBGStringKey.IBGThankYouAlertTitleStringName
IBGStringKey.IBGTitleText
IBGStringKey.IBGTwoFingerSwipeStartAlertTextStringName
IBGStringKey.IBGVideoDurationErrorMessage
IBGStringKey.IBGVideoDurationErrorTitle
IBGStringKey.IBGVideoGalleryErrorMessageStringName
IBGStringKey.IBGVideoPressRecordTitle
IBGStringKey.IBGVideoRecordingFailureMessageStringName
IBGStringKey.IBGiCloudImportErrorAlertMessage
IBGStringKey.IBGiCloudImportErrorAlertTitle
  
// Android
InstabugCustomTextPlaceHolder.Key.AddExtraScreenshot
InstabugCustomTextPlaceHolder.Key.AddImageFromGallery
InstabugCustomTextPlaceHolder.Key.AddVideo
InstabugCustomTextPlaceHolder.Key.AddVoiceMessage
InstabugCustomTextPlaceHolder.Key.AudioRecordingPermissionDenied
InstabugCustomTextPlaceHolder.Key.BetaWelcomeMessageFinishStepContent
InstabugCustomTextPlaceHolder.Key.BetaWelcomeMessageFinishStepTitle
InstabugCustomTextPlaceHolder.Key.BetaWelcomeMessageHowToReportStepContent
InstabugCustomTextPlaceHolder.Key.BetaWelcomeMessageHowToReportStepTitle
InstabugCustomTextPlaceHolder.Key.BetaWelcomeMessageWelcomeStepContent
InstabugCustomTextPlaceHolder.Key.BetaWelcomeMessageWelcomeStepTitle
InstabugCustomTextPlaceHolder.Key.BugReportHeader
InstabugCustomTextPlaceHolder.Key.ChatsTeamStringName
InstabugCustomTextPlaceHolder.Key.CommentFieldHintForBugReport
InstabugCustomTextPlaceHolder.Key.CommentFieldHintForFeedback
InstabugCustomTextPlaceHolder.Key.CommentFieldHintForQuestion
InstabugCustomTextPlaceHolder.Key.ConversationsListTitle
InstabugCustomTextPlaceHolder.Key.ConversationTextFieldHint
InstabugCustomTextPlaceHolder.Key.EmailFieldHint
InstabugCustomTextPlaceHolder.Key.FeaturesRequest
InstabugCustomTextPlaceHolder.Key.FeaturesRequestAddFeatureThanksMessage
InstabugCustomTextPlaceHolder.Key.FeaturesRequestAddFeatureToast
InstabugCustomTextPlaceHolder.Key.FeedbackReportHeader
InstabugCustomTextPlaceHolder.Key.InvalidCommentMessage
InstabugCustomTextPlaceHolder.Key.InvalidEmailMessage
InstabugCustomTextPlaceHolder.Key.InvocationHeader
InstabugCustomTextPlaceHolder.Key.LiveWelcomeMessageContent
InstabugCustomTextPlaceHolder.Key.LiveWelcomeMessageTitle
InstabugCustomTextPlaceHolder.Key.QuestionReportHeader
InstabugCustomTextPlaceHolder.Key.RepliesNotificationDismissButton
InstabugCustomTextPlaceHolder.Key.RepliesNotificationReplyButton
InstabugCustomTextPlaceHolder.Key.ReportAddAttachmentHeader
InstabugCustomTextPlaceHolder.Key.ReportBug
InstabugCustomTextPlaceHolder.Key.ReportBugDescription
InstabugCustomTextPlaceHolder.Key.ReportDiscardDialogBody
InstabugCustomTextPlaceHolder.Key.ReportDiscardDialogNegativeAction
InstabugCustomTextPlaceHolder.Key.ReportDiscardDialogPositiveAction
InstabugCustomTextPlaceHolder.Key.ReportDiscardDialogTitle
InstabugCustomTextPlaceHolder.Key.ReportFeedback
InstabugCustomTextPlaceHolder.Key.ReportFeedbackDescription
InstabugCustomTextPlaceHolder.Key.ReportQuestion
InstabugCustomTextPlaceHolder.Key.ReportQuestionDescription
InstabugCustomTextPlaceHolder.Key.ReportReproStepsDisclaimerBody
InstabugCustomTextPlaceHolder.Key.ReportReproStepsDisclaimerLink
InstabugCustomTextPlaceHolder.Key.ReportSuccessfullySent
InstabugCustomTextPlaceHolder.Key.ReproStepsListDescription
InstabugCustomTextPlaceHolder.Key.ReproStepsListEmptyStateDescription
InstabugCustomTextPlaceHolder.Key.ReproStepsListHeader
InstabugCustomTextPlaceHolder.Key.ReproStepsProgressDialogBody
InstabugCustomTextPlaceHolder.Key.RequestFeature
InstabugCustomTextPlaceHolder.Key.RequestFeatureDescription
InstabugCustomTextPlaceHolder.Key.ShakeHint
InstabugCustomTextPlaceHolder.Key.StartChats
InstabugCustomTextPlaceHolder.Key.SuccessDialogHeader
InstabugCustomTextPlaceHolder.Key.SurveysCustomThanksSubtitle
InstabugCustomTextPlaceHolder.Key.SurveysCustomThanksTitle
InstabugCustomTextPlaceHolder.Key.SurveysStoreRatingThanksSubtitle
InstabugCustomTextPlaceHolder.Key.SurveysStoreRatingThanksTitle
InstabugCustomTextPlaceHolder.Key.SurveysWelcomeScreenButton
InstabugCustomTextPlaceHolder.Key.SurveysWelcomeScreenSubtitle
InstabugCustomTextPlaceHolder.Key.SurveysWelcomeScreenTitle
InstabugCustomTextPlaceHolder.Key.SwipeHint
InstabugCustomTextPlaceHolder.Key.VideoPlayerTitle
InstabugCustomTextPlaceHolder.Key.VoiceMessagePressAndHoldToRecord
InstabugCustomTextPlaceHolder.Key.VoiceMessageReleaseToAtta

Updated 7 months ago


What's Next

The locale reflects on all aspects of the SDK. The language might be different, but you'll want to welcome your user either way. The bug reporting and prompt options will also change.

Welcome Message
Bug Reporting
Prompt Options

SDK Locale


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

Suggested Edits are limited on API Reference Pages

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