|
| 1 | +// |
| 2 | +// IBGTypes.h |
| 3 | +// Instabug |
| 4 | +// |
| 5 | +// Copyright: (c) 2013-2016 by Instabug, Inc., all rights reserved. |
| 6 | +// |
| 7 | + |
| 8 | +#import <Foundation/Foundation.h> |
| 9 | + |
| 10 | +/// ------------------------------ |
| 11 | +/// @name User-facing Strings Keys |
| 12 | +/// ------------------------------ |
| 13 | + |
| 14 | +// Predefined keys to be used to override any of the user-facing strings in the SDK. See + [Instabug setValue:forStringWithKey] |
| 15 | + |
| 16 | +extern NSString * const kIBGStartAlertTextStringName; |
| 17 | +extern NSString * const kIBGShakeStartAlertTextStringName; |
| 18 | +extern NSString * const kIBGTwoFingerSwipeStartAlertTextStringName; |
| 19 | +extern NSString * const kIBGEdgeSwipeStartAlertTextStringName; |
| 20 | +extern NSString * const kIBGScreenshotStartAlertTextStringName; |
| 21 | +extern NSString * const kIBGInvalidEmailMessageStringName; |
| 22 | +extern NSString * const kIBGInvalidEmailTitleStringName; |
| 23 | +extern NSString * const kIBGInvalidCommentMessageStringName; |
| 24 | +extern NSString * const kIBGInvalidCommentTitleStringName; |
| 25 | +extern NSString * const kIBGInvocationTitleStringName; |
| 26 | +extern NSString * const kIBGTalkToUsStringName; |
| 27 | +extern NSString * const kIBGReportBugStringName; |
| 28 | +extern NSString * const kIBGReportFeedbackStringName; |
| 29 | +extern NSString * const kIBGEmailFieldPlaceholderStringName; |
| 30 | +extern NSString * const kIBGCommentFieldPlaceholderForBugReportStringName; |
| 31 | +extern NSString * const kIBGCommentFieldPlaceholderForFeedbackStringName; |
| 32 | +extern NSString * const kIBGChatReplyFieldPlaceholderStringName; |
| 33 | +extern NSString * const kIBGAddScreenRecordingMessageStringName; |
| 34 | +extern NSString * const kIBGAddVoiceMessageStringName; |
| 35 | +extern NSString * const kIBGAddImageFromGalleryStringName; |
| 36 | +extern NSString * const kIBGAddExtraScreenshotStringName; |
| 37 | +extern NSString * const kIBGAudioRecordingPermissionDeniedTitleStringName; |
| 38 | +extern NSString * const kIBGAudioRecordingPermissionDeniedMessageStringName; |
| 39 | +extern NSString * const kIBGScreenRecordingPermissionDeniedMessageStringName; |
| 40 | +extern NSString * const kIBGMicrophonePermissionAlertSettingsButtonTitleStringName; |
| 41 | +extern NSString * const kIBGMicrophonePermissionAlertLaterButtonTitleStringName; |
| 42 | +extern NSString * const kIBGChatsTitleStringName; |
| 43 | +extern NSString * const kIBGTeamStringName; |
| 44 | +extern NSString * const kIBGRecordingMessageToHoldTextStringName; |
| 45 | +extern NSString * const kIBGRecordingMessageToReleaseTextStringName; |
| 46 | +extern NSString * const kIBGMessagesNotificationTitleSingleMessageStringName; |
| 47 | +extern NSString * const kIBGMessagesNotificationTitleMultipleMessagesStringName; |
| 48 | +extern NSString * const kIBGScreenshotTitleStringName; |
| 49 | +extern NSString * const kIBGOkButtonTitleStringName; |
| 50 | +extern NSString * const kIBGCancelButtonTitleStringName; |
| 51 | +extern NSString * const kIBGThankYouAlertTitleStringName; |
| 52 | +extern NSString * const kIBGThankYouAlertMessageStringName; |
| 53 | +extern NSString * const kIBGAudioStringName; |
| 54 | +extern NSString * const kIBGScreenRecordingStringName; |
| 55 | +extern NSString * const kIBGImageStringName; |
| 56 | +extern NSString * const kIBGReachedMaximimNumberOfAttachmentsTitleStringName; |
| 57 | +extern NSString * const kIBGReachedMaximimNumberOfAttachmentsMessageStringName; |
| 58 | +extern NSString * const kIBGSurveyEnterYourAnswerTextPlaceholder; |
| 59 | +extern NSString * const kIBGSurveyNoAnswerTitle; |
| 60 | +extern NSString * const kIBGSurveyNoAnswerMessage; |
| 61 | +extern NSString * const kIBGSurveySubmitTitle; |
| 62 | +extern NSString * const kIBGVideoPressRecordTitle; |
| 63 | +extern NSString * const kIBGLowDiskStorageTitle; |
| 64 | +extern NSString * const kIBGLowDiskStorageMessage; |
| 65 | +extern NSString * const kIBGCollectingDataText; |
| 66 | +extern NSString * const kIBGExtraFieldIsRequiredText; |
| 67 | +extern NSString * const kIBGExtraFieldMissingDataText; |
| 68 | + |
| 69 | +/// ----------- |
| 70 | +/// @name Enums |
| 71 | +/// ----------- |
| 72 | + |
| 73 | +/** |
| 74 | + The event used to invoke the feedback form. |
| 75 | + */ |
| 76 | +typedef NS_ENUM(NSInteger, IBGInvocationEvent) { |
| 77 | + /** No event will be registered to show the feedback form, you'll need to code your own and call the method showFeedbackForm. */ |
| 78 | + IBGInvocationEventNone, |
| 79 | + /** Shaking the device while in any screen to show the feedback form. */ |
| 80 | + IBGInvocationEventShake, |
| 81 | + /** Taking a screenshot using the Home+Lock buttons while in any screen to show the feedback form. */ |
| 82 | + IBGInvocationEventScreenshot, |
| 83 | + /** Swiping two fingers left while in any screen to show the feedback form. */ |
| 84 | + IBGInvocationEventTwoFingersSwipeLeft, |
| 85 | + /** Swiping one finger left from the right edge of the screen to show the feedback form, substituted with IBGInvocationEventTwoFingersSwipeLeft on iOS 6.1.3 and earlier. */ |
| 86 | + IBGInvocationEventRightEdgePan, |
| 87 | + /** Shows a floating button on top of all views, when pressed it takes a screenshot. */ |
| 88 | + IBGInvocationEventFloatingButton |
| 89 | +}; |
| 90 | + |
| 91 | +/** |
| 92 | + The color theme of the different UI elements. |
| 93 | + */ |
| 94 | +typedef NS_ENUM(NSInteger, IBGColorTheme) { |
| 95 | + IBGColorThemeLight, |
| 96 | + IBGColorThemeDark |
| 97 | +}; |
| 98 | + |
| 99 | +/** |
| 100 | + The mode used upon invocating the SDK. |
| 101 | + */ |
| 102 | +typedef NS_ENUM(NSInteger, IBGInvocationMode) { |
| 103 | + IBGInvocationModeNA, |
| 104 | + IBGInvocationModeBugReporter __attribute__((deprecated)), |
| 105 | + IBGInvocationModeFeedbackSender __attribute__((deprecated)), |
| 106 | + IBGInvocationModeNewBug, |
| 107 | + IBGInvocationModeNewFeedback, |
| 108 | + IBGInvocationModeNewChat, |
| 109 | + IBGInvocationModeChatsList |
| 110 | +}; |
| 111 | + |
| 112 | +/** |
| 113 | + Type of report to be submitted. |
| 114 | + */ |
| 115 | +typedef NS_ENUM(NSInteger, IBGReportType) { |
| 116 | + IBGReportTypeBug, |
| 117 | + IBGReportTypeFeedback |
| 118 | +}; |
| 119 | + |
| 120 | +/** |
| 121 | + Type of feedback to be submitted. |
| 122 | + */ |
| 123 | +__attribute__((deprecated)) |
| 124 | +typedef NS_ENUM(NSInteger, IBGFeedbackType) { |
| 125 | + IBGFeedbackTypeBug, |
| 126 | + IBGFeedbackTypeFeedback, |
| 127 | + IBGFeedbackTypeCrash |
| 128 | +}; |
| 129 | + |
| 130 | +/** |
| 131 | + State of Issue after SDK dismiss. |
| 132 | + */ |
| 133 | +__attribute__((deprecated)) |
| 134 | +typedef NS_ENUM(NSInteger, IBGIssueState) { |
| 135 | + /** Issue is submitted */ |
| 136 | + IBGIssueSubmitted, |
| 137 | + /** Issue is cancelled */ |
| 138 | + IBGIssueCancelled, |
| 139 | + /** Issue is in progress, adding extra screenshot */ |
| 140 | + IBGIssueInProgress |
| 141 | +}; |
| 142 | + |
| 143 | +/** |
| 144 | + Type of SDK dismiss. |
| 145 | + */ |
| 146 | +typedef NS_ENUM(NSInteger, IBGDismissType) { |
| 147 | + /** Dismissed after report submit */ |
| 148 | + IBGDismissTypeSubmit, |
| 149 | + /** Dismissed via cancel */ |
| 150 | + IBGDismissTypeCancel, |
| 151 | + /** Dismissed while taking screenshot */ |
| 152 | + IBGDismissTypeAddAttachment |
| 153 | +}; |
| 154 | + |
| 155 | +/** |
| 156 | + Supported locales. |
| 157 | + */ |
| 158 | +typedef NS_ENUM(NSInteger, IBGLocale) { |
| 159 | + IBGLocaleArabic, |
| 160 | + IBGLocaleChineseSimplified, |
| 161 | + IBGLocaleChineseTaiwan, |
| 162 | + IBGLocaleChineseTraditional, |
| 163 | + IBGLocaleCzech, |
| 164 | + IBGLocaleDanish, |
| 165 | + IBGLocaleDutch, |
| 166 | + IBGLocaleEnglish, |
| 167 | + IBGLocaleFrench, |
| 168 | + IBGLocaleGerman, |
| 169 | + IBGLocaleItalian, |
| 170 | + IBGLocaleJapanese, |
| 171 | + IBGLocaleKorean, |
| 172 | + IBGLocaleNorwegian, |
| 173 | + IBGLocalePolish, |
| 174 | + IBGLocalePortugese, |
| 175 | + IBGLocalePortugueseBrazil, |
| 176 | + IBGLocaleRussian, |
| 177 | + IBGLocaleSlovak, |
| 178 | + IBGLocaleSpanish, |
| 179 | + IBGLocaleSwedish, |
| 180 | + IBGLocaleTurkish |
| 181 | +}; |
| 182 | + |
| 183 | +/** |
| 184 | + Verbosity level of the SDK debug logs. This has nothing to do with IBGLog, and only affect the logs used to debug the |
| 185 | + SDK itself. |
| 186 | + |
| 187 | + Defaults to IBGSDKDebugLogsLevelError. Make sure you only use IBGSDKDebugLogsLevelError or IBGSDKDebugLogsLevelNone in |
| 188 | + production builds. |
| 189 | + */ |
| 190 | +typedef NS_ENUM(NSInteger, IBGSDKDebugLogsLevel) { |
| 191 | + IBGSDKDebugLogsLevelVerbose, |
| 192 | + IBGSDKDebugLogsLevelDebug, |
| 193 | + IBGSDKDebugLogsLevelError, |
| 194 | + IBGSDKDebugLogsLevelNone |
| 195 | +}; |
| 196 | + |
| 197 | +/** |
| 198 | + Keys for publicly-facing strings in the SDK. |
| 199 | + Deprecated. Use NSString constants like IBGShakeStartAlertTextStringName and IBGEmailFieldPlaceholderStringName instead. |
| 200 | + */ |
| 201 | +typedef NS_ENUM(NSInteger, IBGString) { |
| 202 | + IBGStringShakeHint, |
| 203 | + IBGStringSwipeHint, |
| 204 | + IBGStringEdgeSwipeStartHint, |
| 205 | + IBGStringStartAlertText, |
| 206 | + IBGStringInvalidEmailMessage, |
| 207 | + IBGStringInvalidEmailTitle, |
| 208 | + IBGStringInvalidCommentMessage, |
| 209 | + IBGStringInvalidCommentTitle, |
| 210 | + IBGStringInvocationHeader, |
| 211 | + IBGStringTalkToUs, |
| 212 | + IBGStringReportBug, |
| 213 | + IBGStringReportFeedback, |
| 214 | + IBGStringEmailFieldHint, |
| 215 | + IBGStringCommentFieldHintForBugReport, |
| 216 | + IBGStringCommentFieldHintForFeedback, |
| 217 | + IBGStringAddScreenRecordingMessage, |
| 218 | + IBGStringAddVoiceMessage, |
| 219 | + IBGStringAddImageFromGallery, |
| 220 | + IBGStringAddExtraScreenshot, |
| 221 | + IBGStringAudioRecordingPermissionDeniedTitle, |
| 222 | + IBGStringAudioRecordingPermissionDeniedMessage, |
| 223 | + IBGStringScreenRecordingPermissionDeniedMessage, |
| 224 | + IBGStringMicrophonePermissionAlertSettingsButtonTitle, |
| 225 | + IBGStringMicrophonePermissionAlertLaterButtonTitle, |
| 226 | + IBGStringChatsHeaderTitle, |
| 227 | + IBGStringTeam, |
| 228 | + IBGStringRecordingMessageToHoldText, |
| 229 | + IBGStringRecordingMessageToReleaseText, |
| 230 | + IBGStringMessagesNotification, |
| 231 | + IBGStringMessagesNotificationAndOthers, |
| 232 | + IBGStringScreenshotHeaderTitle, |
| 233 | + IBGStringOkButtonTitle, |
| 234 | + IBGStringCancelButtonTitle, |
| 235 | + IBGStringThankYouText, |
| 236 | + IBGStringThankYouAlertText, |
| 237 | + IBGStringAudio, |
| 238 | + IBGStringScreenRecording, |
| 239 | + IBGStringImage, |
| 240 | + IBGStringSurveyEnterYourAnswerPlaceholder, |
| 241 | + kIBGStringSurveyNoAnswerTitle, |
| 242 | + kIBGStringSurveyNoAnswerMessage, |
| 243 | + kIBGStringSurveySubmitTitle, |
| 244 | + kIBGStringVideoPressRecordTitle, |
| 245 | + kIBGStringLowDiskStorageTitle, |
| 246 | + kIBGStringLowDiskStorageMessage, |
| 247 | + kIBGStringCollectingDataText, |
| 248 | + kIBGStringExtraFieldIsRequiredText, |
| 249 | + kIBGStringExtraFieldMissingDataText |
| 250 | +}; |
| 251 | + |
| 252 | +/** |
| 253 | + The prompt option selected in Instabug prompt. |
| 254 | + */ |
| 255 | +typedef NS_ENUM(NSInteger, IBGPromptOption) { |
| 256 | + IBGPromptOptionChat, |
| 257 | + IBGPromptOptionBug, |
| 258 | + IBGPromptOptionFeedback |
| 259 | +}; |
0 commit comments