You're 3 steps away from adding great in-app support to your Xamarin App.
Guide to integrating the Xamarin plugin for the Helpshift SDK.
The Helpshift SDK .zip contains the following files:
Newtonsoft JSON.Net
Android Support Library v4
Android Support Library v7
Android Support Library v7 Cardview
Android Support Library v7 Recyclerview
Android Support Design Library
To use Helpshift's APIs, please import the Helpshift's namespace as given below.
using HelpshiftApi;
Helpshift SDK uniquely identifies your App with the combination of:
To get the API Key
, Domain Name
and the App ID
, navigate to Settings
>SDK (for Developers)
in your agent dashboard and scroll down to "Initializing Helpshift" section. show me
Select your App from the dropdown and copy the three tokens to be passed when initializing Helpshift.
Initialize Helpshift by calling the method Install(apiKey, domain, appId) API
using HelpshiftApi; . . . HelpshiftCore.Initialize(HelpshiftApiProviderType.HelpshiftApiProviderTypeSupport); HelpshiftInstallConfig config = new HelpshiftInstallConfig.Builder().Build(); HelpshiftCore.Install ("<API_KEY>", "<DOMAIN_NAME>", "<APP_ID>", config);
Applicable to version 3.0.0 and above.
using HelpshiftApi; . . . HelpshiftCore.Initialize(HelpshiftApiProviderType.HelpshiftApiProviderTypeSupport); Dictionary<string, object> config = new Dictionary<string, object>(); HelpshiftCore.Install ("<API_KEY>", "<DOMAIN_NAME>", "<APP_ID>", config);
The install call is required only in the onCreate
of the Application
class of your app.
Helpshift is now integrated in your app. You should now use the support APIs to present FAQ or conversation screens inside your app.
Run your app, and try starting a test conversation using the ShowConversation API call. Then goto your Helpshift agent dashboard and reply to experience the in-app messaging.
Sample usage for FAQs and conversation APIs:
HelpshiftAPIConfig faqApiConfig = new HelpshiftAPIConfig.Builder().Build(); helpBtn.Click += delegate { HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, faqApiConfig); }; HelpshiftAPIConfig convApiConfig = new HelpshiftAPIConfig.Builder().Build(); contactBtn.Click += delegate { HelpshiftApi.HelpshiftSupport.ShowConversation(activity, convApiConfig); };
Applicable to version 3.0.0 and above.
Dictionary<string, object> faqApiConfigDictionary = new Dictionary<string, object>(); helpBtn.Click += delegate { HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, faqApiConfigDictionary); }; Dictionary<string, object> convApiConfigDictionary = new Dictionary<string, object>(); contactBtn.Click += delegate { HelpshiftApi.HelpshiftSupport.ShowConversation(activity, convApiConfigDictionary); };