@tyrads.com/tyrads-sdk 1.1.6-beta.4 → 1.1.6
Sign up to get free protection for your applications and to get access to all the features.
- package/package.json +1 -1
- package/readme.md +71 -0
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -22,3 +22,74 @@ import Tyrads from '@tyrads.com/tyrads-sdk';
|
|
|
22
22
|
Tyrads.showOffers();
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
+
|
|
26
|
+
</br>
|
|
27
|
+
<details>
|
|
28
|
+
<summary><strong>Launch Mode</strong></summary>
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
</br>
|
|
32
|
+
|
|
33
|
+
##### Min SDK version required: v1.1.6
|
|
34
|
+
##### Works only for iOS
|
|
35
|
+
|
|
36
|
+
</br>
|
|
37
|
+
|
|
38
|
+
Tyrads SDK provides the ability to open the Offerwall in a webkit view that is embedded in the app to provide a seamless user experience. Also, it provides the ability to open the Offerwall in an external browser (Safari) if Apple's app store policy does not approve the in-app rewards system for the app.
|
|
39
|
+
|
|
40
|
+
Available launch modes:
|
|
41
|
+
- `launchMode: 3` - opens the Offerwall in an external browser (Safari)
|
|
42
|
+
- `launchMode: 2` - opens the Offerwall in a webkit view that is embedded in the app
|
|
43
|
+
|
|
44
|
+
```js
|
|
45
|
+
|
|
46
|
+
// Note: The launchMode parameter is optional, if not specified the default would be opening the Offerwall in an external browser (Safari)
|
|
47
|
+
|
|
48
|
+
Tyrads.showOffers({ launchMode: 3 });// provide launchMode: 2 to open the Offerwall in a webkit view that is embedded in the app
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
</details>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</br>
|
|
56
|
+
<details>
|
|
57
|
+
<summary><strong>Deeplinking Routes</strong></summary>
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
</br>
|
|
61
|
+
|
|
62
|
+
##### Min SDK version required: v1.1.6
|
|
63
|
+
|
|
64
|
+
</br>
|
|
65
|
+
|
|
66
|
+
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.
|
|
67
|
+
|
|
68
|
+
Available routes and their usage:
|
|
69
|
+
- `campaigns` - opens the Campaigns Page
|
|
70
|
+
- `campaigns-activated` - opens the Activated Campaigns Page
|
|
71
|
+
- `campaign-details` - opens the Campaign Details Page (requires campaignID)
|
|
72
|
+
- `campaign-tickets` - opens the Campaign Tickets Page (requires campaignID)
|
|
73
|
+
|
|
74
|
+
```js
|
|
75
|
+
|
|
76
|
+
// Default route (Campaigns Page)
|
|
77
|
+
Tyrads.showOffers();
|
|
78
|
+
|
|
79
|
+
// Explicitly specifying the Campaigns Page
|
|
80
|
+
Tyrads.showOffers({ route: "campaigns" });
|
|
81
|
+
|
|
82
|
+
// Activated Campaigns Page
|
|
83
|
+
Tyrads.showOffers({ route: "campaigns-activated" });
|
|
84
|
+
|
|
85
|
+
// Campaign Details Page (requires campaignID)
|
|
86
|
+
Tyrads.showOffers({ route: "campaign-details", campaignID: "your_campaign_id_here" });
|
|
87
|
+
|
|
88
|
+
// Campaign Tickets Page (requires campaignID)
|
|
89
|
+
Tyrads.showOffers({ route: "campaign-tickets", campaignID: "your_campaign_id_here" });
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
</details>
|
|
93
|
+
|
|
94
|
+
</br></br>
|
|
95
|
+
|