rn-linkrunner 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -171,7 +171,7 @@ const setUserData = async () => {
|
|
|
171
171
|
|
|
172
172
|
This function triggers the original deeplink that led to the app installation. Call it only after your main navigation is initialized and all deeplink-accessible screens are ready to receive navigation events.
|
|
173
173
|
|
|
174
|
-
Note: For this to work properly make sure you have added verification objects on the [Linkrunner Dashboard](https://www.linkrunner.io/settings?
|
|
174
|
+
Note: For this to work properly make sure you have added verification objects on the [Linkrunner Dashboard](https://www.linkrunner.io/settings?sort_by=activity-1&s=store-verification).
|
|
175
175
|
|
|
176
176
|
```jsx
|
|
177
177
|
import linkrunner from 'rn-linkrunner';
|
|
@@ -238,15 +238,15 @@ Note: Either `paymentId` or `userId` must be provided when calling `removePaymen
|
|
|
238
238
|
|
|
239
239
|
Below is a simple guide on where to place each function in your application:
|
|
240
240
|
|
|
241
|
-
| Function
|
|
242
|
-
|
|
|
243
|
-
| `linkrunner.init`
|
|
244
|
-
| `linkrunner.signup`
|
|
245
|
-
| `linkrunner.setUserData`
|
|
246
|
-
| `linkrunner.triggerDeeplink` | After navigation initialization | Once after your navigation is ready to handle deep links |
|
|
247
|
-
| `linkrunner.trackEvent`
|
|
248
|
-
| `linkrunner.capturePayment`
|
|
249
|
-
| `linkrunner.removePayment`
|
|
241
|
+
| Function | Where to Place | When to Call |
|
|
242
|
+
| --------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------- |
|
|
243
|
+
| [`linkrunner.init`](#initialisation) | In your `App.tsx` within a `useEffect` hook with empty dependency array | Once when the app starts |
|
|
244
|
+
| [`linkrunner.signup`](#signup) | In your onboarding flow | Once after user completes the onboarding process |
|
|
245
|
+
| [`linkrunner.setUserData`](#set-user-data) | In your authentication logic | Every time the app is opened and the user is logged in |
|
|
246
|
+
| [`linkrunner.triggerDeeplink`](#trigger-deeplink-for-deferred-deep-linking) | After navigation initialization | Once after your navigation is ready to handle deep links |
|
|
247
|
+
| [`linkrunner.trackEvent`](#track-event) | Throughout your app where events need to be tracked | When specific user actions or events occur |
|
|
248
|
+
| [`linkrunner.capturePayment`](#capture-payment) | In your payment processing flow | When a user makes a payment |
|
|
249
|
+
| [`linkrunner.removePayment`](#remove-payment) | In your payment cancellation/refund flow | When a payment needs to be removed |
|
|
250
250
|
|
|
251
251
|
### Facing issues during integration?
|
|
252
252
|
|