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

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(.french)
[Instabug setLocale:IBGLocaleFrench];

Here are the possible locale values:

arabic    
chinese     
chinese 
czech
danish
english
french
german
italian
japanese
korean
polish
portugese
portugueseBrazil
russian
slovak
spanish
swedish
turkish
IBGLocaleArabic    
IBGLocaleChineseSimplified    
IBGLocaleChineseTaiwan
IBGLocaleChineseTraditional
IBGLocaleCzech
IBGLocaleDanish
IBGLocaleDutch
IBGLocaleEnglish
IBGLocaleFrench
IBGLocaleGerman
IBGLocaleItalian
IBGLocaleJapanese
IBGLocaleKorean
IBGLocaleNorwegian
IBGLocalePolish
IBGLocalePortugese
IBGLocalePortugueseBrazil
IBGLocaleRussian
IBGLocaleSlovak
IBGLocaleSpanish
IBGLocaleSwedish
IBGLocaleTurkish

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 to your users individually using the following method.

Instabug.setValue("Please enter a correct email address", forStringWithKey: kIBGInvalidEmailTitleStringName)
[Instabug setValue:@"Please enter a correct email address" forStringWithKey:kIBGInvalidEmailTitleStringName];

Here are the possible keys:

kIBGStartAlertTextStringName
kIBGShakeStartAlertTextStringName
kIBGTwoFingerSwipeStartAlertTextStringName
kIBGEdgeSwipeStartAlertTextStringName
kIBGScreenshotStartAlertTextStringName
kIBGInvalidEmailMessageStringName
kIBGInvalidEmailTitleStringName
kIBGInvalidCommentMessageStringName
kIBGInvalidCommentTitleStringName
kIBGInvocationTitleStringName
kIBGTalkToUsStringName
kIBGReportBugStringName
kIBGReportFeedbackStringName
kIBGEmailFieldPlaceholderStringName
kIBGCommentFieldPlaceholderForBugReportStringName
kIBGCommentFieldPlaceholderForFeedbackStringName
kIBGChatReplyFieldPlaceholderStringName
kIBGAddScreenRecordingMessageStringName
kIBGAddVoiceMessageStringName
kIBGAddImageFromGalleryStringName
kIBGAddExtraScreenshotStringName
kIBGAudioRecordingPermissionDeniedTitleStringName
kIBGAudioRecordingPermissionDeniedMessageStringName
kIBGScreenRecordingPermissionDeniedMessageStringName
kIBGMicrophonePermissionAlertSettingsButtonTitleStringName
kIBGMicrophonePermissionAlertLaterButtonTitleStringName
kIBGChatsTitleStringName
kIBGTeamStringName
kIBGRecordingMessageToHoldTextStringName
kIBGRecordingMessageToReleaseTextStringName
kIBGMessagesNotificationTitleSingleMessageStringName
kIBGMessagesNotificationTitleMultipleMessagesStringName
kIBGScreenshotTitleStringName
kIBGOkButtonTitleStringName
kIBGSendButtonTitleStringName
kIBGCancelButtonTitleStringName
kIBGThankYouAlertTitleStringName
kIBGThankYouAlertMessageStringName
kIBGAudioStringName
kIBGScreenRecordingStringName
kIBGImageStringName
kIBGReachedMaximimNumberOfAttachmentsTitleStringName
kIBGReachedMaximimNumberOfAttachmentsMessageStringName
kIBGVideoRecordingFailureMessageStringName
kIBGSurveyEnterYourAnswerTextPlaceholder
kIBGSurveyNoAnswerTitle
kIBGSurveyNoAnswerMessage
kIBGVideoPressRecordTitle
kIBGCollectingDataText
kIBGLowDiskStorageTitle
kIBGLowDiskStorageMessage
kIBGInboundByLineMessage
kIBGExtraFieldIsRequiredText
kIBGExtraFieldMissingDataText
kIBGSurveyIntroTitleText
kIBGSurveyIntroDescriptionText
kIBGSurveyIntroTakeSurveyButtonText
kIBGSurveyIntroDismissButtonText
kIBGSurveyThankYouTitleText
kIBGSurveyThankYouDescriptionText
kIBGSurveysNPSLeastLikelyStringName
kIBGSurveysNPSMostLikelyStringName
kIBGSurveyNextButtonTitle
kIBGSurveySubmitButtonTitle
kIBGSurveyAppStoreThankYouTitle
kIBGSurveyAppStoreButtonTitle
kIBGExpectedResultsStringName
kIBGActualResultsStringName
kIBGStepsToReproduceStringName
kIBGReplyButtonTitleStringName
kIBGFeatureRequestsTitle 
kIBGFeatureDetailsTitle 
kIBGStringFeatureRequestsRefreshText 
kIBGFeatureRequestSortingByRecentlyUpdatedText 
kIBGFeatureRequestSortingByTopVotesText 
kIBGFeatureRequestErrorStateTitleLabel 
kIBGFeatureRequestErrorStateDescriptionLabel 
kIBGBetaWelcomeMessageWelcomeStepTitle;
kIBGBetaWelcomeMessageWelcomeStepContent;
kIBGBetaWelcomeMessageHowToReportStepTitle;
kIBGBetaWelcomeMessageHowToReportStepContent;
kIBGBetaWelcomeMessageFinishStepTitle;
kIBGBetaWelcomeMessageFinishStepContent;
kIBGBetaWelcomeDoneButtonTitle;
kIBGLiveWelcomeMessageTitle;
kIBGLiveWelcomeMessageContent;

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