Sharing Screen

Referral Campaign Sharing Screen

The sharing screen appears once the user logins into the REFERRAL campaign. The screen enables him to refer to the brand with his friends or acquaintances so that he could earn points and rewards for referring. Here is a detailed guide to know how to launch the sharing screen in InviteReferrals.
Steps

Pass User Details for Auto-Login (Single Sign In)

invitereferrals.userDetails((String)name, (String)email, (String)mobile, (String)campaignID, (String)subscriptionID, (String)customValues, callback);

Example:

invitereferrals.userDetails("abc", "[email protected]", "9876543210", "0", null, null, callback  );

// callback function be like this
callback(msg){
    alert("success msg= "+ msg);
  }

Parameters :

Parameter

Description

Value

name (string)

customer's name

eg. tom

email (string)

customer's email id

mobile (string)

customer's mobile number

Response

You will get a response in terms of success or failure.

In case of SUCCESS :

{"Authentication":"success","hitApi":"true"}

In case of FAILURE

{"Authentication":"fail","Error":"Invalid authentication","ErrorType":"4"}

Following are the error-type with error message we receive in this callback in failure response.

Error Message

Error Type

Scenario

Data not found

2

In case when data not found

Campaign data not found

3

In case campaign is InActive or no campaign found

Invalid authentication

4

Invalid authentication

No internet connection

7

Parameter missing, email id or mobile no as per IR account setting cannot be empty or null

No internet connection

8

No internet connection

Launch Referral Campaign Screen

Add the following line in your custom button click. Replace CampaignID with the id of the referral campaign. Default campaignID will be applied if no campaignID is specified.

inviteReferrals.inline_btn((String)campaignID);

Example:

inviteReferrals.inline_btn("0");
//Note:- Passing  0 in campaign id will launch your default campaign in your panel (A campaign id must be set as default campaign to use this feature).

Show Refer a friend Popup

Simply, add the following line in the activity in which you want to show the referral program popup.

inviteReferrals.invite((String)CUSTOM_RULE);

Example​:

inviteReferrals.invite("home");

Close Button Listener for Referral Screen

Trigger this callback whenever the referral screen of the SDK is closed using the CLOSE button in the actionbar. Here, you can perform any task on the close of the referral screen. For example, any alert or any popup.

inviteReferrals.closeButtonListener(callback);

Get Sharing Details

This function can be used, in case you want to design your own custom sharing screen, using our sharing data.

invitereferrals.getSharingDetails((String)name, (String)email, (String)mobile, (int)CampaignId), callback);

Example​:

iInvitereferrals.shared.getSharingDetails( "Neeraj", "[email protected]", "0987654321", 0, callback);

Sample Response

{
   "Authentication":"success",
   "CustomerName":"Jack90",
   "Email":"[email protected]",
   "referral_code":"JACKQTVU",
   "referral_link":"https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136",
   "unique_code":"null",
   "stats":{
      "totalInvites":"0",
      "totalClicks":"0",
      "totalConverts":"0"
   },
   "popup_shareText":"Refer and win #Referral #Contests #inviteReferrals",
   "shareSubject":"Explore Tagnpin Referral Contest",
   "inviteMail":"<table>\r\n    <tr>\r\n        <td>Hi,<\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td><\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td>Your friend Jack90, has invited you to try Tagnpin through his referral link<\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td><\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td>Accept the invitation by clicking the link mentioned below.<\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td>https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136<\/td>\r\n    <\/tr>\r\n<\/table>",
   "whatsp_txt":"Refer and win #Referral #Contests #inviteReferrals",
   "shareText":"https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136 Refer and win #Referral #Contests #inviteReferrals",
   "email_shareText":"https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136?r=email <table>\r\n    <tr>\r\n        <td>Hi,<\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td><\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td>Your friend Jack90, has invited you to try Tagnpin through his referral link<\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td><\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td>Accept the invitation by clicking the link mentioned below.<\/td>\r\n    <\/tr>\r\n    <tr>\r\n        <td>https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136<\/td>\r\n    <\/tr>\r\n<\/table>",
   "whatsapp_shareText":"https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136?r=wa Refer and win #Referral #Contests #inviteReferrals",
   "sms_shareText":"https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136?r=sms Refer and win #Referral #Contests #inviteReferrals",
   "twitter_shareText":"https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136?r=tw Refer and win #Referral #Contests #inviteReferrals",
   "linkedin_shareText":"https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136?r=li Refer and win #Referral #Contests #inviteReferrals",
   "pinterest_shareText":"https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136?r=pi Refer and win #Referral #Contests #inviteReferrals",
   "fb_shareText":"{\nfbLink= https:\/\/tagnpinkp.ref-r.com\/c\/i\/27894\/59810136?r=fb Refer and win #Referral #Contests #inviteReferrals\n fbImage= https:\/\/s3.ap-south-1.amazonaws.com\/tagnpin-mumbai\/images\/fb_46287_27894_1.jpg\n}",
   "loginScreenData":"<link rel=\"stylesheet\" href=\"https:\/\/maxcdn.bootstrapcdn.com\/bootstrap\/3.3.5\/css\/bootstrap.min.css\"><style>body{background: transparent;}<\/style><div class=\"text-center\">\n    <h3><br \/>Heading<\/h3>\n    <p class=\"lead\">\n        The description of your referral campaign \n        <br>\n        comes here\n    <\/p>\n<\/div>",
   "shareScreenData":"<link rel=\"stylesheet\" href=\"https:\/\/maxcdn.bootstrapcdn.com\/bootstrap\/3.3.5\/css\/bootstrap.min.css\"><style>body{background: transparent;}<\/style><div class=\"text-center\">\n<h3><br \/>Heading<\/h3>\n<p class=\"lead\">The description of your referral campaign <br \/>comes here<\/p>\n<\/div>"
}

What’s Next