Welcome Message

Show Welcome Message

Show​ ​a welcome​ ​message​ ​to​ ​the customer​ ​if​ ​he/she​ ​comes​ ​through​ ​a referral​ ​of​ ​his/her​ ​friend.

InviteReferralsApi.getInstance(activityContext).showWelcomeMessage();

InviteReferralsApi.getInstance(activityContext).showWelcomeMessage()

📘

NOTE

Its content or UI cannot be customized from the IR-SDK side.

Content will be displayed in a dialog box. The popup will be displayed every time you call this function either until the user does not click on the close button or until the referrer has expired.

Get Referrer Code

A referrer code refers to the unique combination of numbers and letters which is assigned by the brand to its customers which they can share with their friends and acquaintances, so that when a referee in turn signs up to the brand, the brand gets to know that the newly registered user has come via the reference of their friend who is already a customer.

This function will provide the referrer code in a callback if it's available in the SDK.

InviteReferralsApi.getInstance(activityContext).getReferrerCode(new IRTrackReferrerCode() {
   @Override
   public void getReferrerCode(String refCode) {
       // Log.e(TAG, "Refer Code = " + refCode);
   }
});

InviteReferralsApi.getInstance(activityContext).getReferrerCode( object : IRTrackReferrerCode {
     override fun getReferrerCode(p0: String?) {
         //do your task here
     }
})

Get Referring Params

The users might come from different sources as well as from different campaigns or advertisements. So, to figure out from where they have signed up to your website, you will be required to bifurcate the data and you can even further analyze which campaigns or sources are working best for you.

This function is a return type function, which returns JSON data. It will provide you with all UTM-related data if it is captured from the application.

InviteReferralsApi.getInstance(activityContext).getReferringParams();

InviteReferralsApi.getInstance(activityContext).getReferringParams()

A sample output is provided below: -

{
   "ir_code":"MGB9Q7HR",
   "utm_campaign":"Default_Campaign",
   "utm_medium":"others",
   "ir_ref":"xxxxxxx-xxx-xxxx-xxxx-xxx-xxxx-xxx-xxxx-xxxx-xxx",
   "utm_source":"invitereferrals",
   "utm_content":"50763857"
}