Start to finish before your coffee is ready.

Installing HintPod in your app should take just five minutes. If you face any issues drop us a message. You need a HintPod account to get started. If you don't have an account yet, create one for free.

Looking for Android instructions?

iOS

Installation

Create a Cocoapod file in your app's directory if you don't already have one.

pod create

Add the HintPod iOS library to your project using CocoaPods.

pod 'HintPod'

Then install the pod.

pod install

Authentication

Import HintPod and initialise it in your AppDelegate's didFinishLaunchingWithOptions function.

let user = HPUser(id: [user_id], name: [user_name])

HintPod.authenticate(user: user, projectId: [project_id], companyId: [api_key])

You'll need to assign your users a unique ID. This can be the same one you use to identify them in your app. You can optionally assign them a name, otherwise we'll assign a fun one for them 😁. If a user just completed the sign-in flow, we recommend authenticating them then to ensure they can still use HintPod.

You also need to register both your project ID and API key. These can be found on your dashboard. The keys are separate to allow for multiple projects in the future.

Presentation

HintPod.present(title: [customisable_title])

You can present HintPod at any time using the above function. By default, the screen has "Suggestions" as its title but you can optionally change that to whatever you want. Leaving the title field as nil will fallback to the default title.

Done

You're good to go! Add a suggestion through your app and watch the magic happen 😍


Android

Installation

Add the HintPod library to your gradle file.

implementation 'com.hintpod:hintpod:[latest_version]'

You can find the latest version on BinTray. The minimum sdk version HintPod is compatible with is API 23: Android 6.0 Marshmallow.

Authentication

Import HintPod and initialise it in your app's onCreate method.

new HintPod().verify([user_id], [project_id], [api_key], [user_name]);
HintPod().verify([user_id], [project_id], [api_key], [user_name])

You'll need to assign your users a unique ID. This can be the same one you use to identify them in your app. You can optionally assign them a name, otherwise we'll assign a fun one for them 😁. If a user just completed the sign-in flow, we recommend authenticating them then to ensure they can still use HintPod.

You also need to register both your project ID and API key. These can be found on your dashboard. The keys are separate to allow for multiple projects in the future.

Presentation

You can customise the plugin using the following two optional methods.

new HintPod().setTitle([customisable_title]);
new HintPod().setHintPodTheme(R.style.AppTheme);
HintPod().setTitle([customisable_title])
HintPod().setHintPodTheme(R.style.AppTheme)

Then present it at any time using the following method.

new HintPod().start(context);
HintPod().start(context)

Done

You're good to go! Add a suggestion through your app and watch the magic happen 😍