Helpshift provides several config options which can be used to customize behaviour of the SDK.
All the public APIs in the SDK should be called after initializing the SDK via HelpshiftSdk.install() API
Upon setting enableLogging to true
, Helpshift SDK logs will be generated in the Xcode console. Turning on logging can help developers resolve common integration issues.
HelpshiftSdk.ENABLE_LOGGING
true
/false
false
using Helpshift; // other imports public class MyGameControl : MonoBehaviour { private HelpshiftSdk help; void Awake(){ this.help = HelpshiftSdk.GetInstance(); Dictionary<string, object> configMap = new Dictionary<string, object>(); configMap.Add(HelpshiftSdk.ENABLE_LOGGING, true); help.Install(appId, domainName, configMap); } }
If you do not want the in-app notifications support provided by the Helpshift SDK, set this flag to false
.
This behaviour is different for Android, please refer here
HelpshiftSdk.ENABLE_INAPP_NOTIFICATION
true
/false
true
using Helpshift; // other imports public class MyGameControl : MonoBehaviour { private HelpshiftSdk help; void Awake(){ this.help = HelpshiftSdk.GetInstance(); Dictionary<string, object> configMap = new Dictionary<string, object>(); configMap.Add(HelpshiftSdk.ENABLE_INAPP_NOTIFICATION, true); help.Install(appId, domainName, configMap); } }
Customization of the appearance of in-app notification using the flag inAppNotificationAppearance
. 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
HelpshiftSdk.INAPP_NOTIFICATION_APPEARANCE
bannerBackgroundColor
/ textColor
The bannerBackgroundColor represents the background color of the banner of the in-app notification. The value for this key should be a 6-characters string representing the HEX value of the color.
The textColor represents the text color of the text shown in the in-app notification. The value for this key should be a 6-characters string representing the HEX value of the color
using Helpshift; // other imports public class MyGameControl : MonoBehaviour { private HelpshiftSdk help; void Awake(){ this.help = HelpshiftSdk.GetInstance(); Dictionary<string, object> configMap = new Dictionary<string, object>(); Dictionary<string, object> inAppNotificationAppearance = new Dictionary<string, object>(); inAppNotificationAppearance.Add(HelpshiftSdk.INAPP_NOTIFICATION_BANNER_BACKGROUND_COLOR, "000000"); inAppNotificationAppearance.Add(HelpshiftSdk.INAPP_NOTIFICATION_BANNER_TEXT_COLOR, "FFFFFF"); configMap.Add(HelpshiftSdk.INAPP_NOTIFICATION_APPEARANCE, inAppNotificationAppearance); help.Install(appId, domainName, configMap); } }
Controls the visibility of the Helpshift Contact Us button when a user is viewing FAQs. You can customize this option to make it easier or more difficult to contact support. If specified, this configuration takes precedence over the value of Enable Contact Us set on admin dashboard.
Possible values are "ALWAYS"
/ "AFTER_VIEWING_FAQS"
/ "AFTER_MARKING_ANSWER_UNHELPFUL"
/ "NEVER"
.
For example
using Helpshift; // other imports public class MyGameControl : MonoBehaviour { private HelpshiftSdk help; void Awake() { this.help = HelpshiftSdk.GetInstance(); help.Install(appId, domainName); } void OpenHelpshift() { Dictionary<string, object> configMap = new Dictionary<string, object>(); configMap.Add("enableContactUs", "AFTER_VIEWING_FAQS"); help.ShowFAQs(configMap); } }
ALWAYS
for paid users and AFTER_VIEWING_FAQS
for unpaid ones.ALWAYS
for local users and AFTER_VIEWING_FAQS
for foreign ones.In the config
dictionary of help.ShowConversation(config);
API at the time of calling this API, setting the fullPrivacy
option to true
ensures COPPA compliance by:
userName
and userEmail
, with fullPrivacy
set to true
, Helpshift will not use the userName
and userEmail
values.Moreover, in scenarios where the user attaches objectionable content, it becomes a huge COPPA compliance concern. This option helps to solve this problem.
For example
using Helpshift; // other imports public class MyGameControl : MonoBehaviour { private HelpshiftSdk help; void Awake() { this.help = HelpshiftSdk.GetInstance(); help.Install(appId, domainName); } void OpenHelpshift() { Dictionary<string, object> configMap = new Dictionary<string, object>(); configMap.Add("fullPrivacy", "true"); help.ShowConversation(configMap); } }
This config represents the theming of Helpshift SDK. For more information check design.
This config represents the tracking user actions. For more information check tracking.