Deeplinking Routes

Min SDK version required: v1.1.4

The Tyrads SDK supports deeplinking to specific sections of the offerwall. When initializing or interacting with the SDK, you can specify a route to open a particular page. For campaign-specific routes, you'll need to provide the campaignID as well.

Available routes and their usage:

• offers - opens the Campaigns Page

• active-offers - opens the Activated Campaigns Page

• offers/[id] - opens the Campaign Details Page (requires campaignID)

• support - opens the Campaign Tickets Page (requires campaignID)

// Note: CAMPAIGNS is the default route when no specific route is provided
Tyrads.instance.showOffers(context);

// Explicitly specifying the Campaigns Page
Tyrads.instance.showOffers(context, route: "offers");
//or use TyradsDeepRoutes class to avoid typos
Tyrads.instance.showOffers(context, route: TyradsDeepRoutes.OFFERS);

// Activated Campaigns Page
Tyrads.instance.showOffers(context, route: "active-offers");
// or using TyradsDeepRoutes class like
Tyrads.instance.showOffers(context, route: TyradsDeepRoutes.ACTIVE_OFFERS);

// Campaign Details Page (requires campaignID)
Tyrads.instance.showOffers(context, route: "offer", campaignID: "your_campaign_id_here");
// or using TyradsDeepRoutes class like
Tyrads.instance.showOffers(context, route: TyradsDeepRoutes.OFFER, campaignID: "your_campaign_id_here");

// Campaign Tickets Page (requires campaignID)
Tyrads.instance.showOffers(context, route: "support", campaignID: "your_campaign_id_here");
// or using TyradsDeepRoutes class like
Tyrads.instance.showOffers(context, route: TyradsDeepRoutes.SUPPORT, campaignID: "your_campaign_id_here");

Basic Usage

Here is an example of how to use the @tyrads.com/tyrads-sdk package:

import  Tyrads  from  '@tyrads.com/tyrads-sdk';
const  TYR_SDK_API_KEY  =  'YOUR_API_KEY';
const  TYR_SDK_API_SECRET  =  'YOUR_API_SECRET';
const  initializeTyrSDK  = () => {
  Tyrads.init(TYR_SDK_API_KEY, TYR_SDK_API_SECRET);
  Tyrads.loginUser(userId);
};

const  initializeAndShowOffers  = () => {
 initializeTyrSDK();
 Tyrads.showOffers();
};