Callbacks

The AppVirality SDK 2.0 for Android is now leaner & more effective. Like any SDK based solution, this one employs a lot of callbacks internally which help it to gather data points or info.

We shall explore & lay out the key elements that compose these callback.
We shall also discover what each of these callbacks intend to achieve.

The idea here is to simply help you as a developer understand the system, and enable you to adapt your integration to suit specific needs of your app. Below is the list of Callbacks defined inside the SDK for its interoperability:

Initialize the SDK

---

This callback is used while initializing the AppVirality SDK.
Initializing the SDK is critical to loading of the growth hacks & retrieving user relevant info to use forward in the subsequent activities.

The callback returns a bunch of details about the user, like:

Below code block is how it is implemented:

appVirality.init(userDetails, new AppVirality.AppViralitySessionInitListener() {
    @Override
    public void onInitFinished(boolean isInitialized, JSONObject responseData, String errorMsg) {
        Log.i("AppVirality: ", "InitWithAppKey Status " + isInitialized);
        if (responseData != null)
            Log.i("AppVirality: ", "userDetails " + responseData.toString());
    }
});

Gets you all the details of active campaigns eligible for a user

---

This callback is used to get a list of all the active campaigns details like campaignId, campaignName, growthHackType, etc.

This callback is critical to preparing the Campaign inside a user’s app. Based on the applicable campaign, and if it is available in the active campaign array (returned in this callback) – you can go ahead and refresh the images required for those campaigns specifically.

appVirality.getCampaigns(growthHackType, new AppVirality.CampaignDetailsListener() {
    @Override
    public void onGetCampaignDetails(ArrayList<CampaignDetail> campaignDetails, boolean refreshImages, String errorMsg) {
        
    }
});

Used while updating user details or info like name, image, etc

---

This must be executed in conjunction with the “/updateappuserinfo” API call to update a user’s details or information.

appVirality.updateAppUserInfo(userDetails, new AppVirality.UpdateUserInfoListener() {
    @Override
    public void onResponse(boolean isSuccess, String errorMsg) {
        
    }
});

Used in conjunction with the “/saveconversionevent” API to register/save an event’s occurrence

---

This callback is used while saving a conversion event using the “/saveconversionevent” API request.

appVirality.saveConversionEvent(event, transactionValue, transactionUnit, campaignId, growthHackType, new AppVirality.ConversionEventListener() {
    @Override
    public void onResponse(boolean isSuccess, String message, String errorMsg) {
        Toast.makeText(getApplicationContext(), message, Toast.LENGTH_LONG).show();
    }
});

Used to receive & consume the Referral Code, when applied by a Friend

---

A new user i.e. a Friend, while signing up might be prompted to enter the Referral Code. When the code is entered, it must be consumed and the attribution to the Referrer must follow thereafter.
The code is consumed and the “/setreferrercode” API call gets executed hereafter. Use this callback only if the attribution has not happened already from Referral Link.

This callback handles all of that!

appVirality.submitReferralCode(referralCode, new AppVirality.SubmitReferralCodeListener() {
    @Override
    public void onResponse(boolean isSuccess, JSONObject responseData, String errorMsg) {
        
    }
});

Use this to obtain the Campaign Terms & Conditions

---

This callback allows you to get the set of Terms & Conditions for a campaign, as maintained in the AppVirality Dashboard against the particular campaign.

Ideally this simply grabs the response from the “/campaignterms” API request

appVirality.getCampaignTerms(campaignId, new AppVirality.CampaignTermsListener() {
    @Override
    public void onGetCampaignTerms(String terms, String errorMsg) {
        
    }
});

Applicable when the user initiates a request to customize his/her Referral Code

---

When the user would choose to customize his referral code, then this particular callback shall come in play.

This simply plays along to accommodate and grab the response from customizereferralcode API request.

appVirality.customizeReferralCode(referralCode, new AppVirality.CustomizeRefCodeListener() {
    @Override
    public void onCustomRefCodeSet(boolean isSuccess, String errorMsg) {
        try {
            
        } catch (Exception e) {
        }
    }
});

Runs a check to ascertain whether a user has been attributed to a Referrer

---

This callback is used to check the attribution status for a user, it returns the user and referrer data in the callback.

This method can be used to check if the user is an existing user, referred user, etc.

appVirality.checkAttribution(referrerCode, new AppVirality.CheckAttributionListener() {
    @Override
    public void onResponse(JSONObject responseData, String errorMsg) {
        try {
            if (responseData != null){
                if (responseData.getBoolean("isExistingUser")){
                    // User already exists
                } else {
                     // Its a new user
                }
            }         
        } 
        catch (Exception e) {
            
        }
    }
});

To get the user balance

---

When requesting/pulling out the users’ balances and credits for the app promotions, this callback does the needful.

It simply triggers & consumes the results from the execution of the getuserbalance API.

This callback is critical to your app’s Earnings display activity. The response data obtained would contain all the credits/earnings of the user – be it Coupon or Wallet credit. Each reward shall be nested under the respective growth hack type i.e. Loyalty, Word Of Mouth (Referrals), etc.

appVirality.getUserRewardDetail(campaignId, new AppVirality.UserBalanceListener() {
    @Override
    public void onGetRewardDetails(JSONObject responseData, String errorMsg) {
        
    }
});

To get the user rewards detail

---

When requesting/pulling out the users’ rewards details and credits for the app promotions, this callback does the needful.

It simply triggers & consumes the results from the execution of the getuserrewards API.

This callback is critical to your app’s Earnings display activity. The response data obtained would contain all the credits/earnings of the user – be it Coupon or Wallet credit. Each reward shall be nested under the respective growth hack type i.e. Loyalty, Word Of Mouth (Referrals), etc.

appVirality.getUserRewards(growthHackType, campaignId, new AppVirality.UserRewardsListener() {
    @Override
    public void onResponse(JSONObject responseData, String errorMsg) {
        
    }
});

Use this to get the list of coupons tagged to a particular user at any given time

---

For handling the feature of displaying all the coupons tagged to a user, in case you have a coupon driven incentive schema for your app – this particular callback shall be employed.

Simply speaking it consumes the response data from the /getusercoupons API call and delivers it as a JSONArray.

Take note that this list of coupon details includes an individual image for each of these coupons, wherever applicable. This improves your scope for presenting these coupons to the end user, if you were to choose a custom display UI for the same – ignoring the one provided by AppVirality as default.

appVirality.getUserCoupons(new AppVirality.UserCouponsListener() {
    @Override
    public void onGetCoupons(boolean isSuccess, JSONArray userCoupons, String errorMsg) {
        
    }
});

Gets you the list (with detail) of the Coupon Pools a user can choose a reward from

---

AppVirality has the novelty of offering a system that enables your app to offer users an option to choose their desired coupon from a choice of Coupon Pools. This keeps things interesting for the users and allows them to have goals to achieve with respect to the growth campaigns you run, i.e. they may aspire for that BookMyShow or Amazon coupon that you have on the offer.

This particular feature is enabled using this callback, which basically talks with the getcouponpools API call and delivers the list of eligible coupon pools for a user, based on his/her rewards tally. Use this code block to achieve the same:

appVirality.getCouponPools(campaignId, new AppVirality.CouponPoolsListener() {
    @Override
    public void onGetCouponPools(JSONObject responseData, String errorMsg) {

    }
});

Allows for the redeeming or rewarding of coupons for a user’s redemption request

---

Given the coupon pools allow users to choose their desired coupon variant for their stacked up rewards, it is only logical that a coupon redeemer logic shall be requisite next.

This callback does that job for you, as it executes the redeemrewards API call and redeems the appropriate coupon for the end user – finally delivering whether the coupon got redeemed or not along with an error message if applicable.

appVirality.redeemFromPool(poolId, new AppVirality.CouponRedeemListener() {
    @Override
    public void onResponse(boolean isRedeemed, String errorMsg) {
        
    }
});

Delivers you the list of friends for a particular user

---

Most app referral programs out there do not really captivate the imagination of the user, and what a pity that is! If you were not really able to see whom you brought/introduced to the app, via the App Referral program & hence earned rewards for yourself – you are missing a major picture of the activity. Where else could you be motivated to do this? What will prompt you back to try referring more friends?

This callback returns you the list of friends a user may have brought onto the app, through their referral invite – simply by tapping on the /getfriendslist API call.

appVirality.getFriends(int pageIndex, int pageSize, GetFriendsListener getFriendsListener() {
    @Override
    public void onGetFriends(JSONObject responseData, String errorMsg) {
        
    }
});

Delivers the referrer and user details – useful for personalizing user welcoming/on-boarding

---

This callback is typically important when you want to customize the on-boarding of a user, who’s been acquired via a Referral Invite. This delivers you details like:

appVirality.getReferrerDetails(new AppVirality.ReferrerDetailsReadyListener() {
    @Override
    public void onReferrerDetailsReady(JSONObject referrerDetails) {
        
    }
});

Ascertains the attribution of a shared product to the user/referrer who shared

---

This callback is used to record the attribution for a shared product. It calls the /recordproductattribution API to attribute share to the user who shared the product.

appVirality.recordProductAttribution(clickId, new AppVirality.ProductAttributionListener() {
    @Override
    public void onResponse(JSONObject responseData, String errorMsg) {
        
    }
});

 

---

In the above callbacks we are returning an error message in case the API call gets failed due to some reason.
Below is a list of error messages returned in the callbacks upon failure and their description: