Helpshift provides several configuration options that you can use to customize the behavior of the SDK. Use these options in conjunction with our Helpshift APIs.
All the public APIs in the SDK should be called after initializing the SDK via Helpshift installWithPlatformId API
Upon setting enableLogging
to YES
, Helpshift SDK logs will be generated in the Xcode console. This will be useful for debugging the SDK during integration.
enableLogging
YES
/ NO
NO
installWithPlatformId:domain:config:
Example:
NSDictionary *config = @{ @"enableLogging":@YES }; [Helpshift installWithPlatformId:@"YOUR_PLATFORM_ID" domain:@"YOUR_DOMAIN_NAME" config:config];
let config = ["enableLogging": true] Helpshift.install(withPlatformId: "YOUR_PLATFORM_ID", domain: "YOUR_DOMAIN", config: config)
If you do not want the in-app notifications support provided by the Helpshift SDK, set this flag to NO
.
enableInAppNotification
YES
/ NO
YES
installWithPlatformId:domain:config:
Example:
NSDictionary *config = @{ @"enableInAppNotification":@YES }; [Helpshift installWithPlatformId:@"YOUR_PLATFORM_ID" domain:@"YOUR_DOMAIN_NAME" config:config];
let config = ["enableInAppNotification": true] Helpshift.install(withPlatformId: "YOUR_PLATFORM_ID", domain: "YOUR_DOMAIN", config: config)
This config represents the appearance of the in-app notification in the SDK. When the agent/bot sends a message and the user is using the app, an in-app banner is shown and the appearance of that banner can be customized using this dictionary
inAppNotificationAppearance
bannerBackgroundColor
/ textColor
installWithPlatformId:domain:config:
Example:
NSDictionary *config = @{ @"inAppNotificationAppearance": @{ @"bannerBackgroundColor": @"000000", @"textColor": @"FFFFFF" } }; [Helpshift installWithPlatformId:@"YOUR_PLATFORM_ID" domain:@"YOUR_DOMAIN_NAME" config:config];
let config = ["inAppNotificationAppearance": ["bannerBackgroundColor":"000000", "textColor":"FFFFFF"]] Helpshift.install(withPlatformId: "YOUR_PLATFORM_ID", domain: "YOUR_DOMAIN", config: config)
The presentFullScreenOniPad
flag will determine whether to present support views in UIModalPresentationFullScreen
or UIModalPresentationFormSheet
modal presentation style on iPad. This config has no effect on iPhones.
The default value is NO, presents support views as UIModalPresentationFormSheet
. When the value is set to YES
, support views are presented in UIModalPresentationFullScreen
. Use this setting to show Helpshift in full-screen mode.
presentFullScreenOniPad
YES
/ NO
NO
showConversation
Example:
NSDictionary *config = @{ @"presentFullScreenOniPad": @YES }; [Helpshift showConversationWith:self config:config];
let config = ["presentFullScreenOniPad": true] Helpshift.install(withPlatformId: "YOUR_PLATFORM_ID", domain: "YOUR_DOMAIN", config: config)
In scenarios where the user attaches objectionable content in the screenshots, it becomes a huge COPPA concern. The enableFullPrivacy option will help solve this problem.
Setting the enableFullPrivacy option to YES ensures full COPPA compliance by doing the following:
enableFullPrivacy
YES
/ NO
NO
showConversation
, showFAQs
Example:
NSDictionary *config = @{ @"fullPrivacy": @YES }; [Helpshift showConversationWith:self config:config];
let config = ["fullPrivacy": true] Helpshift.showConversation(with:self, config:config)
In your registration process, ask your user for his/her age. If the user's age is 13 or younger, set enableFullPrivacy to YES. This way, you comply with COPPA for your children users, but collect valuable user and device data for your other users.
Please check design page to apply your styles and theming to the SDK.
This config represents the tracking of user actions. For more information, please check tracking.