Helpshift sdk.SDK Configuration
Helpshift sdk.Guide: Native SDK Implementation
Install time configurations.SDK Configuration – Helpshift for Android
SDK Configuration Helpshift provides several config options which can be used to customize behaviour of the SDK. These options are boolean flags which can be passed with the Helpshift APIs such as showConversation, showFAQs etc. Applicable to SDK version and above. ARTICLE FRESHNESS AUDIENCE We prepared this material for well qualified Helpshift administrators. FOUNDATIONAL KNOWLEDGE A Help Center is an in-app destination for customer service engagements and user support, centered around exactly one product or service. Help Center is a legacy product — bound to legacy SDKs — that supports upgrading to Help Center The screen orientation of Helpshift SDK screens can be fixed by setting the screenOrientation to constants available in the ActivityInfo class. For example, you may want to fix the orientation to _ORIENTATION_PORTRAIT for mobile users and _ORIENTATION_LANDSCAPE for tablet users.
Helpshift sdk.Guide: Native SDK Implementation – Helpshift Knowledge Base Helpshift Knowledge Base
The screen orientation of Helpshift SDK screens can be fixed by setting the screenOrientation to constants available in the ActivityInfo class. For example, you may want to fix the orientation to _ORIENTATION_PORTRAIT for mobile users and _ORIENTATION_LANDSCAPE for tablet users. ARTICLE FRESHNESS AUDIENCE We prepared this material for well qualified Helpshift administrators. FOUNDATIONAL KNOWLEDGE A Help Center is an in-app destination for customer service engagements and user support, centered around exactly one product or service. Help Center is a legacy product — bound to legacy SDKs — that supports upgrading to Help Center Available from SDK version and above. Starting from Android Oreo, Helpshift notifications will create a default channel named In-app Support. If you want to customize the name and description for the default channel, you can do so by using the following resources in your file: Example Support Name Example Support .
SDK X Archives – Helpshift Knowledge Base Helpshift Knowledge Base
SDK Configuration – Android – Helpshift for Unity
New to Helpshift? Request Trial. By default the application icon is used as the notification icon. You can customize the notification icon using the config in the install call.
If you want to specify the large notification icon also to show up in the notification tray, you can specify that using the config in the install call. If you do not want the in-app notification support provided by the Helpshift SDK, you can set the flag to false.
The default value of this flag is true i. By default the default device notification sound is used for helpshift notifications. You can customize the notification sound using the config in the install call. Starting from Android Oreo, Helpshift notifications will create a default channel named In-app Support. If you want to customize the name and description for the default channel, you can do so by using the following resources in your strings.
If you want to customize the notification channels, you can create your own custom channels and provide their channel IDs using the following config API:. Add the font to your assets folder. You can do this from the file manager or by dragging the font file to the folder in Android Studio. Pass the font location relative to the assets folder as follows during installation.
If the font file DancingScript-Regular. The screen orientation of Helpshift SDK screens can be fixed by setting the screenOrientation to constants available in the ActivityInfo class. For example, you may want to fix the orientation to ActivityInfo. Due to a bug in Android OS 8. This happens only when the targetSDKVersion is greater than 26 and certain android theming flags mentioned in the bug are used for the Activity.
On SDK v7. These will be useful for debugging the SDK during integration. Turning on this logging could help the developer resolve common integration issues. The Helpshift SDK will collect internal error logs and report them to our systems to ensure that we become aware of runtime crashes and we have enough information to fix them.
The enableContactUs flag will determine whether the Contact Us button is shown. So if you want to override that you can pass the arguments in a dictionary.
This flag has no effect for the showConversation API call. Read more about the new conversational experience here. The gotoConversationAfterContactUs flag will determine whether the user lands up in the conversation screen after starting a new conversation via “Contact Us”. This only makes sense if the enableContactUs flag takes on the default value.
If requireEmail flag is set to true , an e-mail address is required while starting a new conversation. Default value is false i. Once requireEmail flag is set, the SDK will use that value for all new conversations until it is changed again. The hideNameAndEmail flag will hide the name and email fields when the user starts a new conversation. When the flag is set to true the name and email fields will be hidden. If set to false the default behaviour will resume.
If “Allow anonymous issues” is ON, under app settings in the agent dashboard, then this flag will be ignored. If this config is used, it will fill the reply box with the given text when the chat screen is opened. It is useful if you want to minimise the user efforts to start a new support conversation. For example, if you already know that the user is trying to connect with support to fix the problem of billing process, then you can use the conversationPrefillText API option to prefill the billing specific information and start with a new conversation.
A graphical indicator is shown to the end user if an Agent is currently replying to the same conversation. For SDK v7. 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. To send personally identifiable information through custom meta-data, the information must be added inside a dictionary with a “private-data” key. If this option is set to true , this data will be removed when the user starts a new conversation.
If the user’s age is 13 or younger, set enableFullPrivacy to true. This way, you comply with COPPA for your children users, but collect valuable user and device data for your other users.
The Helpshift Android SDK will show the conversation resolution question to the user to confirm if the conversation was resolved. After the Issue has been resolved, the user will be taken back to the “Start a new conversation” state. This SDK configuration is deprecated with v7. However if true value is passed, it will be respected.
If you want to show the Resolution Question to your users when an issue is resolved, you can turn the feature Resolution Question , ON from the in-app configuration page on the Admin dashboard. The final behavior of the showConversationResolutionQuestion flag will depend on both the Dashboard side config and the API config flag.
It will be turned ON if any of the values is set to true. On resolving the conversation from the admin dashboard will now take the user directly to the “Start a new conversation” state.
If you want to disable the conversation resolution question, set showConversationResolutionQuestion to false. Default value is true , ie. In this case, you would configure the showHelp button a button which triggers Helpshift SDK in the following way :. Once a particular flow is selected, the subsequent Contact Us buttons will not redirect to Guided Issue Filing again.
They will function as normal Contact Us buttons. This is to avoid an infinite loop of Guided Issue Filing screens. This configuration will work only when there is no open conversation for the user, otherwise every Contact Us button will transition to the chat screen. The showConversationInfoScreen flag will determine if the user can see the Conversation info on the conversation feed. It’s default value is set to 1 for all languages and it can be configured per language.
If number of characters are less than the defined minimum length requirement then an error is displayed to the user. If you want to have minimum length as 5 characters for Korean language and 10 characters for all other languages then you can achieve this as shown below:. Put the following integer resource in integers. Starting from Android 6. This approach streamlines the app install process, since the user does not need to grant permissions when they install or update the app.
It also gives the user more control over the app’s functionality; for example, a user could choose to give a camera app access to the camera, but not to the device location.
The user can revoke the permissions at any time by going to the app’s Settings screen. The storage permissions can be removed from AndroidManifest. The Helpshift SDK has 4 features that require storage permissions. The following is the behavior for these 4 features based on whether the permission is present in AndroidManifest.
Starting from Helpshift SDK v6. Flag screenOrientation values integer values for orientation from ActivityInfo class default ActivityInfo. Default Support. For 3. There is no check in place to check if he actually was not able to find a solution to his problem in the FAQs. If your application requires another level of ticket deflection, we have added a new option to the enableContactUs flag from sdk version 4.
This will also remove the Contact Us button from the search results screen. I want to report a Billing issue. Once enableFullPrivacy flag is set, the SDK will use that value for all further sessions until it is changed again. For SDK versions 6. If requiredEmail is true, enableFullPrivacy will override this configuration and set the email requirement as optional. For hiding name and email for all users, developers enable a Dashboard configuration named “Allow anonymous issues”.
This will allow developers to hide name and email for a specific set of users exposed to the enableFullPrivacy flag. For SDK versions 7. Works as normal attachments are downloaded and rendered in chat screen by sdk’s own download manager. User granted the permission Works as normal User did not grant the permission User is shown permission dialog. If user denies the permission then show a requirement description msg with intent to launch the app settings page User can’t download the attachment unless he grants the permission.
Uri will be passed to system provided download service and it will start download with progress bar in notification drawer.
Helpshift Sdk will just show the toast indicating that download has started. User is allowed to trigger the download multiple times. Sdk would not show any progress in the chat screen. Caching will not work. Image will be reloaded every time the user visits the particular single question screen. User granted the permission: User profile will be persisted across uninstalls User did not grant the permission: User profile will not be persisted across uninstalls.