Follow our migration instructions to [upgrade from SDK 2.x to 3.0](/migration-docs/README.md) or refer to our [2.x integration instruction](https://github.com/pendo-io/pendo-mobile-sdk/blob/2.22.5/README.md). 10 | 11 | 12 | - Native: 13 | [Android](/android/pnddocs/native-android.md) | 14 | [iOS](/ios/pnddocs/native-ios.md) 15 | - React Native: 16 | - Using React Navigation: 17 | [Android](/android/pnddocs/rn-android.md) | 18 | [iOS](/ios/pnddocs/rn-ios.md) 19 | - Using React Native Navigation: 20 | [Android](/android/pnddocs/rnn-android.md) | 21 | [iOS](/ios/pnddocs/rnn-ios.md) 22 | - Using Expo with Expo Router: 23 | [Android](/android/pnddocs/expo_router-android.md) | 24 | [iOS](/ios/pnddocs/expo_router-ios.md) 25 | - Using Expo with React Navigation: 26 | [Android](/android/pnddocs/expo_rn-android.md) | 27 | [iOS](/ios/pnddocs/expo_rn-ios.md) 28 | - Using Expo with React Native Navigation 29 | [Android](/android/pnddocs/expo_rnn-android.md) | 30 | [iOS](/ios/pnddocs/expo_rnn-ios.md) 31 | - Xamarin Forms: 32 | [Android](/android/pnddocs/xamarin_forms-android.md) | 33 | [iOS](/ios/pnddocs/xamarin_forms-ios.md) 34 | - MAUI: 35 | [Android](/android/pnddocs/xamarin_maui-android.md) | 36 | [iOS](/ios/pnddocs/xamarin_maui-ios.md) 37 | - Flutter: 38 | [Android](/android/pnddocs/flutter-android.md) | 39 | [iOS](/ios/pnddocs/flutter-ios.md) | 40 | [Native with Flutter components](/other/native-with-flutter-components.md) 41 | 42 | For integration using signed metadata see: [JWT integration instructions](https://support.pendo.io/hc/en-us/articles/360039616892-Send-signed-metadata-with-JWT) 43 | 44 | 45 | ## API documentation 46 | 47 | - [Native Android](/api-documentation/native-android-apis.md) 48 | - [Native iOS](/api-documentation/native-ios-apis.md) 49 | - [React Native](/api-documentation/rn-apis.md) 50 | - [Xamarin Forms](/api-documentation/xamarin-forms-apis.md) 51 | - [MAUI](/api-documentation/xamarin-maui-apis.md) 52 | - [Flutter](/api-documentation/flutter-apis.md) 53 | 54 | 55 | ## Additional resources 56 | 57 | - [Release notes](https://developers.pendo.io/category/mobile-sdk/) 58 | - [Plan your mobile implementation](https://support.pendo.io/hc/en-us/articles/23527373013275-Plan-your-mobile-implementation) 59 | - [Supported Mobile Frameworks and OS Versions](https://support.pendo.io/hc/en-us/articles/360031861572-Supported-mobile-frameworks-and-OS-versions) 60 | - [Codeless tracking vs Track Events](https://support.pendo.io/hc/en-us/articles/360061487572-Codeless-tracking-vs-Track-Events) 61 | - [Using Pendo with hybrid apps](https://support.pendo.io/hc/en-us/articles/23804736263195-Use-Pendo-with-hybrid-apps) 62 | - [Configuring CNAME Hostnames](https://support.pendo.io/hc/en-us/articles/360047607631-Configure-CNAME-for-Pendo-Mobile) 63 | - [Work with dynamic content in your mobile app](https://support.pendo.io/hc/en-us/articles/24836902488219-Work-with-dynamic-content-in-your-mobile-app) 64 | - [Mobile offline support analytics](https://support.pendo.io/hc/en-us/articles/360043016412-Mobile-offline-support-for-analytics) 65 | 66 | 67 | Visit the [Mobile Resource Center](https://support.pendo.io/hc/en-us/categories/23324531103771-Mobile-implementation) For additional documentation. 68 | 69 | ## Troubleshooting 70 | 71 | - For technical issues, [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues). 72 | 73 | ## Performance benchmarks 74 | 75 | - [Native benchmarks](/benchmarks/NativePerformanceBenchmarks.md) 76 | - [Flutter benchmarks](/benchmarks/FlutterPerformanceBenchmarks.md) 77 | -------------------------------------------------------------------------------- /migration-docs/flutter-2.x-to-3.x-migration.md: -------------------------------------------------------------------------------- 1 | # Flutter migration from version 2.x to version 3.x 2 | 3 | 4 | Follow these instructions to resolve breaking changes in your app:: 5 | 6 |
| Component / API | 10 |Instructions | 11 |
| Minimum Flutter version |
17 |
18 |
19 | 2.x (deprecated): `2.0.0 - 2.10.5`
20 | 21 | 3.x: `3.3.0` 22 | 23 | |
24 |
| Minimum Dart version |
30 |
31 |
32 | 2.x (deprecated): `2.12.0 - 2.16.2`
33 | 34 | 3.x: `2.18` 35 | 36 | |
37 |
| Minimum JAVA version (Relevant for Android apps only) |
43 |
44 |
45 | 2.x (deprecated): `JAVA 8`
46 | 47 | 3.x: `JAVA 11` 48 | 49 | |
50 |
| Minimum Kotlin version (Relevant for Android apps only) |
56 |
57 |
58 | 2.x (deprecated): `1.7.20`
59 | 60 | 3.x: `1.9.0` 61 | 62 | |
63 |
| initSDK | 69 |70 | 71 | Replace `initSDK` by calling `setup` and then `startSession`. 72 | 73 | 2.x (deprecated): 74 | 75 | ```dart 76 | // set session paramaters 77 | final dynamic pendoParams = {'visitorId':'someVisitorID', 78 | 'accountId':'someAccountID', 79 | 'vistiorData': {'age':'25', 'country':'USA'}, 80 | 'accountData': {'tier': '1', 'size':'Enterprise'}}; 81 | 82 | // establish connection to server and start a session 83 | await PendoFlutterPlugin.startSession('someAppKey', pendoParams); 84 | ``` 85 | 86 | 3.x: 87 | 88 | ```dart 89 | // establish connection to server 90 | await PendoFlutterPlugin.setup('someAppKey' 91 | null // pendo app params 92 | ); 93 | 94 | // start a session 95 | await PendoFlutterPlugin.startSession('someVisitorID', 96 | 'someAccountID', 97 | {'age': '25', 'country': 'USA'}, 98 | {'tier': '1', 'size': 'Enterprise'}); 99 | ``` 100 | 101 | | 102 |
| initSDKWithoutVisitor | 108 |109 | 110 | Call `setup` instead of `initSDKWithoutVisitor`. 111 | 112 | 2.x (deprecated): 113 | 114 | ```dart 115 | // establish connection to server 116 | await PendoFlutterPlugin.initSDKWithoutVisitor('someAppKey' 117 | null // pendo app params 118 | ); 119 | ``` 120 | 121 | 3.x: 122 | 123 | 124 | ```dart 125 | // establish connection to server 126 | await PendoFlutterPlugin.setup('someAppKey' 127 | null // pendo app params 128 | ); 129 | ``` 130 | 131 | | 132 |
| clearVisitor | 138 |139 | 140 | Call `startSession` with `null` values instead of `clearVisitor`. 141 | 142 | 2.x (deprecated): 143 | 144 | ```dart 145 | // start a session with an anonymous visitor 146 | await PendoFlutterPlugin.clearVisitor() 147 | ``` 148 | 149 | 3.x: 150 | 151 | ```dart 152 | // start a session with an anonymous visitor 153 | await PendoFlutterPlugin.startSession(null, null, null, null); 154 | ``` 155 | 156 | | 157 |
| switchVisitor | 163 |164 | 165 | Call `startSession` with a new visitor or account id instead of `switchVisitor`. 166 | 167 | 2.x (deprecated): 168 | 169 | ```dart 170 | await PendoFlutterPlugin.switchVisitor('someVisitorID', 171 | 'someAccountID', 172 | {'age': '25', 'country': 'USA'}, 173 | {'tier': '1', 'size': 'Enterprise'}); 174 | ``` 175 | 176 | 3.x: 177 | 178 | ```dart 179 | await PendoFlutterPlugin.startSession('someVisitorID', 180 | 'someAccountID', 181 | {'age': '25', 'country': 'USA'}, 182 | {'tier': '1', 'size': 'Enterprise'}); 183 | ``` 184 | 185 | | 186 |
| setAccountId | 192 |193 | 194 | Call `startSession` with the new account id value instead of `setAccountId`. 195 | 196 | 2.x (deprecated): 197 | 198 | ```dart 199 | await PendoFlutterPlugin.setAccountId('someAccountID'); 200 | ``` 201 | 202 | 3.x: 203 | 204 | ```dart 205 | // start a new session passing in the new accountId 206 | await PendoFlutterPlugin.startSession('someVisitorID', 207 | 'someAccountID', 208 | {'age': '25', 'country': 'USA'}, 209 | {'tier': '1', 'size': 'Enterprise'}); 210 | ``` 211 | 212 | | 213 |
7 | >- Support for React Native's New Architecture (Fabric) is available starting from version 3.7.2. 8 | 9 | >[!IMPORTANT] 10 | >Requirements: 11 | >- Deployment target of `iOS 11` or higher 12 | >- Swift Compatibility `5.7` or higher 13 | >- Xcode `14` or higher 14 | 15 | ## Step 1. Add Pendo dependency 16 | 17 | In the **root folder of your expo app**, add Pendo using one of your package managers: 18 | 19 | ```shell 20 | #example with npx expo 21 | npx expo install rn-pendo-sdk 22 | 23 | #example with npm 24 | npm install --save rn-pendo-sdk 25 | 26 | #example with yarn 27 | yarn add rn-pendo-sdk 28 | ``` 29 | 30 | ## Step 2. Project setup 31 | 32 | >[!NOTE] 33 | >Find your scheme ID in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 34 | 35 | In the `app.config.js` or `app.json`, add the following: 36 | ```json 37 | { 38 | "plugins": [ 39 | [ 40 | "rn-pendo-sdk", 41 | { 42 | "ios-scheme": "YOUR_IOS_SCHEME_ID", 43 | "android-scheme": "YOUR_ANDROID_SCHEME_ID" 44 | } 45 | ] 46 | ] 47 | } 48 | ``` 49 | This configuration enables pendo to enter pair mode to tag Pages and Features. 50 | 51 | ## Step 3. Production bundle - modify Javascript minification 52 | In the `metro.config.js` file, add the following: 53 | ```typescript 54 | module.exports = { 55 | transformer: { 56 | // ... 57 | minifierConfig: { 58 | keep_classnames: true, // Preserve class names 59 | keep_fnames: true, // Preserve function names 60 | mangle: { 61 | keep_classnames: true, // Preserve class names 62 | keep_fnames: true, // Preserve function names 63 | } 64 | } 65 | } 66 | } 67 | ``` 68 | ## Step 4. Integration 69 | 70 | >[!NOTE] 71 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 72 | 73 | In the application main file (App.js/.ts/.tsx), add the following code: 74 | ```typescript 75 | import { PendoSDK, NavigationLibraryType } from 'rn-pendo-sdk'; 76 | import { Navigation } from "react-native-navigation"; 77 | 78 | function initPendo() { 79 | const navigationOptions = {library: NavigationLibraryType.ReactNativeNavigation, navigation: Navigation}; 80 | const pendoKey = 'YOUR_API_KEY_HERE'; 81 | //note the following API will only setup initial configuration, to start collect analytics use start session 82 | PendoSDK.setup(pendoKey, navigationOptions); 83 | } 84 | 85 | initPendo(); 86 | ``` 87 | Initialize Pendo Session where your visitor is being identified (e.g., login, register, etc.). 88 | ```typescript 89 | const visitorId = 'John Smith'; 90 | const accountId = 'Acme Inc.'; 91 | const visitorData = {'Age': 25, 'Country': 'USA'}; 92 | const accountData = {'Tier': 1, 'Size': 'Enterprise'}; 93 | 94 | PendoSDK.startSession(visitorId, accountId, visitorData, accountData); 95 | ``` 96 | 97 | >[!TIP] 98 | >To begin a session for an anonymous visitor, pass ```null``` or an empty string ```''``` as the Visitor ID. You can call the `startSession` API more than once and transition from an anonymous session to an identified session (or even switch between multiple identified sessions). 99 | 100 | ## Step 5. Running the project 101 | To run the project with Pendo integration, you should be able to generate iOS and Android projects. 102 | You can generate them by running `npx expo prebuild`, or `npx expo run:[ios|android]` (which will run prebuild automatically). You can also use development builds in this context - the easiest way to do this is to run `npx expo install expo-dev-client` prior to prebuild or run, and it's also possible to add the library at a later time (additional information can be found here: [Adding custom native code](https://docs.expo.dev/workflow/customizing/#generate-native-projects-with-prebuild)). 103 | 104 | ## Step 6. Verify installation 105 | 106 | 1. In the Pendo UI, go to Settings>Subscription Settings. 107 | 2. Select the **Applications** tab and then your application. 108 | 3. Select the **Install Settings** tab and follow the instructions under Verify Your Installation to ensure you have successfully integrated the Pendo SDK. 109 | 4. Confirm that you can see your app as Integrated under subscription settings. 110 | 111 | ## Limitations 112 | - For the codeless solution to work, all the elements *MUST be wrapped in react-native ui components*.
113 | As with other analytics tools, we are dependent on react-navigation [screen change callbacks](https://reactnavigation.org/docs/screen-tracking/) 114 | which means that codeless tracking analytics is available for screen components only. 115 | 116 | - To support hybrid mode with React Native Navigation, please open a ticket. 117 | 118 | ## Developer documentation 119 | 120 | - API documentation available [here](/api-documentation/rn-apis.md). 121 | 122 | ## Troubleshooting 123 | 124 | - For technical issues, please [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues). 125 | - See our [release notes](https://developers.pendo.io/category/mobile-sdk/). 126 | - For additional documentation, visit our [Help Center](https://support.pendo.io/hc/en-us/categories/23324531103771-Mobile-implementation). 127 | -------------------------------------------------------------------------------- /android/pnddocs/expo_rnn-android.md: -------------------------------------------------------------------------------- 1 | # Expo Android using React Native Navigation 2 | 3 | >[!IMPORTANT] 4 | >- **Expo SDK** 41-54 using React Native Navigation 6+ is supported by our codeless solution. 5 | >- **Expo Go** is not supported. Pendo SDK has a native plugin that is not part of the Expo Go app. 6 | Pendo can *only* be used in development builds. For more about development builds read [adding custom native code with development builds](https://docs.expo.dev/workflow/customizing/). 7 | >- Support for React Native's New Architecture (Fabric) is available starting from version 3.7.2. 8 | 9 | 10 | >[!IMPORTANT] 11 | >Requirements: 12 | >- Android Gradle Plugin `8.0` or higher 13 | >- Kotlin version `1.9.0` or higher 14 | >- JAVA version `11` or higher 15 | >- minSdkVersion `21` or higher 16 | >- compileSDKVersion `35` or higher 17 | 18 | ## Step 1. Add Pendo dependency 19 | 20 | In the **root folder of your expo app**, add Pendo using one of your package managers: 21 | 22 | ```shell 23 | #example with npx expo 24 | npx expo install rn-pendo-sdk 25 | 26 | #example with npm 27 | npm install --save rn-pendo-sdk 28 | 29 | #example with yarn 30 | yarn add rn-pendo-sdk 31 | ``` 32 | 33 | ## Step 2. Project setup 34 | 35 | >[!NOTE] 36 | >Find your scheme ID in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 37 | 38 | In the `app.config.js` or `app.json`, add the following: 39 | ```json 40 | { 41 | "plugins": [ 42 | [ 43 | "rn-pendo-sdk", 44 | { 45 | "ios-scheme": "YOUR_IOS_SCHEME_ID", 46 | "android-scheme": "YOUR_ANDROID_SCHEME_ID" 47 | } 48 | ] 49 | ] 50 | } 51 | ``` 52 | This configuration enables pendo to enter pair mode to tag Pages and Features. 53 | 54 | ## Step 3. Production bundle - modify Javascript minification 55 | 56 | In the `metro.config.js` file, add the following: 57 | ```typescript 58 | module.exports = { 59 | transformer: { 60 | // ... 61 | minifierConfig: { 62 | keep_classnames: true, // Preserve class names 63 | keep_fnames: true, // Preserve function names 64 | mangle: { 65 | keep_classnames: true, // Preserve class names 66 | keep_fnames: true, // Preserve function names 67 | } 68 | } 69 | } 70 | } 71 | ``` 72 | ## Step 4. Integration 73 | 74 | >[!NOTE] 75 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 76 | 77 | In the application main file (App.js/.ts/.tsx), add the following code: 78 | ```typescript 79 | import { PendoSDK, NavigationLibraryType } from 'rn-pendo-sdk'; 80 | import { Navigation } from "react-native-navigation"; 81 | 82 | function initPendo() { 83 | const navigationOptions = {library: NavigationLibraryType.ReactNativeNavigation, navigation: Navigation}; 84 | const pendoKey = 'YOUR_API_KEY_HERE'; 85 | //note the following API will only setup initial configuration, to start collect analytics use start session 86 | PendoSDK.setup(pendoKey, navigationOptions); 87 | } 88 | 89 | initPendo(); 90 | ``` 91 | Initialize Pendo Session where your visitor is being identified (e.g., login, register, etc.). 92 | ```typescript 93 | const visitorId = 'John Smith'; 94 | const accountId = 'Acme Inc.'; 95 | const visitorData = {'Age': 25, 'Country': 'USA'}; 96 | const accountData = {'Tier': 1, 'Size': 'Enterprise'}; 97 | 98 | PendoSDK.startSession(visitorId, accountId, visitorData, accountData); 99 | ``` 100 | 101 | >[!TIP] 102 | >To begin a session for an anonymous visitor, pass ```null``` or an empty string ```''``` as the Visitor ID. You can call the `startSession` API more than once and transition from an anonymous session to an identified session (or even switch between multiple identified sessions). 103 | 104 | ## Step 5. Running the project 105 | 106 | To run the project with Pendo integration, you should be able to generate iOS and Android projects. 107 | You can generate them by running `npx expo prebuild`, or `npx expo run:[ios|android]` (which will run prebuild automatically). You can also use development builds in this context - the easiest way to do this is to run `npx expo install expo-dev-client` prior to prebuild or run, and it's also possible to add the library at a later time (additional information can be found here: [Adding custom native code](https://docs.expo.dev/workflow/customizing/#generate-native-projects-with-prebuild)). 108 | 109 | ## Step 6. Verify installation 110 | 111 | 1. In the Pendo UI, go to Settings>Subscription Settings. 112 | 2. Select the **Applications** tab and then your application. 113 | 3. Select the **Install Settings** tab and follow the instructions under Verify Your Installation to ensure you have successfully integrated the Pendo SDK. 114 | 4. Confirm that you can see your app as Integrated under subscription settings. 115 | 116 | ## Limitations 117 | - For the codeless solution to work, all the elements *MUST be wrapped in react-native ui components*.
118 | As with other analytics tools, we are dependent on react-navigation [screen change callbacks](https://reactnavigation.org/docs/screen-tracking/) 119 | which means that codeless tracking analytics is available for screen components only. 120 | - To support hybrid mode with React Native Navigation, please open a ticket. 121 | 122 | ## Developer documentation 123 | 124 | - API documentation available [here](/api-documentation/rn-apis.md). 125 | 126 | ## Troubleshooting 127 | 128 | - For technical issues, please [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues). 129 | - See our [release notes](https://developers.pendo.io/category/mobile-sdk/). 130 | - For additional documentation, visit our [Help Center](https://support.pendo.io/hc/en-us/categories/23324531103771-Mobile-implementation). 131 | -------------------------------------------------------------------------------- /android/pnddocs/xamarin_forms-android.md: -------------------------------------------------------------------------------- 1 | # Xamarin Forms Android 2 | 3 | >[!NOTE] 4 | >The following integration instructions are relevant for SDK 3.0 or higher.
Follow our migration instructions to [upgrade from SDK 2.x to 3.0](/migration-docs/README.md) or refer to our [2.x integration instruction](https://github.com/pendo-io/pendo-mobile-sdk/blob/2.22.5/README.md). 5 | 6 | >[!IMPORTANT] 7 | >Requirements: 8 | >- .NET 4 9 | >- Xamarin.Forms version 5.0.0.2612 or higher 10 | >- Kotlin version 1.9.0 or higher 11 | 12 | ## Step 1. Install Pendo SDK 13 | 14 | 1. In **Visual Studio** Solution Explorer, right-click on your shared project, then select "Add" - > "Add NuGet Packages…". 15 | 2. Search for: **pendo-xamarin-forms** with latest version.
16 | 3. Press **Add Package**. 17 | 4. #### Using ProGuard / R8 18 | 19 | - If you are using **ProGuard**, the rules that need to be added to ProGuard can be found here: [pendo-proguard.cfg](/android/pnddocs/pendo-proguard.cfg). 20 | 21 | - If you are using **ProGuard(D8/DX only)** to perform compile-time code optimization, and have `{Android SDK Location}/tools/proguard/proguard-android-optimize.txt`, add `!code/allocation/variable` to the `-optimizations` line in your `app/proguard-rules.pro` file. 22 | The optimizations line should look like this: 23 | `-optimizations *other optimizations*,!code/allocation/variable` 24 | 25 | 26 | ## Step 2. Integrate with the Pendo SDK 27 | 28 | >[!NOTE] 29 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 30 | 31 | 1. #### Open the shared project **App.xaml.cs** 32 | 33 | Add the following under 'using': 34 | 35 | ```c# 36 | using PendoSDKXamarin; 37 | 38 | namespace ExampleApp 39 | { 40 | public partial class App : Application 41 | { 42 | private static IPendoInterface pendo = DependencyService.Get
Follow our migration instructions to [upgrade from SDK 2.x to 3.0](/migration-docs/README.md) or refer to our [2.x integration instruction](https://github.com/pendo-io/pendo-mobile-sdk/blob/2.22.5/README.md). 6 | 7 | >[!IMPORTANT] 8 | > Requirements: 9 | > - .NET 4 10 | > - Xamarin.Forms version 5.0.0.2612 or higher 11 | 12 | ## Step 1. Install Pendo SDK 13 | 14 | 1. In **Visual Studio** Solution Explorer, right-click on your shared project, then select "Add" - > "Add NuGet Packages…". 15 | 2. Search for: **pendo-xamarin-forms** with latest version.
16 | 3. Press **Add Package**. 17 | 18 | ## Step 2. Integrate with the Pendo SDK 19 | 20 | >[!NOTE] 21 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 22 | 23 | 1. Open the shared project **App.xaml.cs**: 24 | 25 | Add the following code: 26 | 27 | ```c# 28 | using PendoSDKXamarin; 29 | 30 | namespace ExampleApp 31 | { 32 | public partial class App : Application 33 | { 34 | private static IPendoInterface pendo = DependencyService.Get
146 | As with other analytics tools, we are dependent on react-navigation [screen change callbacks](https://reactnavigation.org/docs/screen-tracking/) 147 | which means that codeless tracking analytics is available for screen components only. 148 | 149 | ## Developer documentation 150 | 151 | - API documentation available [here](/api-documentation/rn-apis.md). 152 | 153 | ## Troubleshooting 154 | 155 | - For technical issues, please [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues). 156 | - See our [release notes](https://developers.pendo.io/category/mobile-sdk/). 157 | - For additional documentation, visit our [Help Center](https://support.pendo.io/hc/en-us/categories/23324531103771-Mobile-implementation). 158 | -------------------------------------------------------------------------------- /android/pnddocs/expo_rn-android.md: -------------------------------------------------------------------------------- 1 | # Expo Android using React Navigation 2 | 3 | >[!IMPORTANT] 4 | >- **Expo SDK** 41-54 using React Navigation 5+ is supported by our codeless solution. 5 | >- **Expo Go** is not supported. Pendo SDK has a native plugin that is not part of the Expo Go app. 6 | Pendo can *only* be used in development builds. For more about development builds read [adding custom native code with development builds](https://docs.expo.dev/workflow/customizing/). 7 | >- Support for React Native's New Architecture (Fabric) is available starting from version 3.7.2. 8 | 9 | 10 | >[!IMPORTANT] 11 | >Requirements: 12 | >- Android Gradle Plugin `8.0` or higher 13 | >- Kotlin version `1.9.0` or higher 14 | >- JAVA version `11` or higher 15 | >- minSdkVersion `21` or higher 16 | >- compileSDKVersion `35` or higher 17 | 18 | ## Step 1. Add Pendo dependency 19 | 20 | In the **root folder of your expo app**, add Pendo using one of your package managers: 21 | 22 | ```shell 23 | #example with npx expo 24 | npx expo install rn-pendo-sdk 25 | 26 | #example with npm 27 | npm install --save rn-pendo-sdk 28 | 29 | #example with yarn 30 | yarn add rn-pendo-sdk 31 | ``` 32 | 33 | ## Step 2. Project setup 34 | 35 | >[!NOTE] 36 | >Find your scheme ID in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 37 | 38 | In the `app.config.js` or `app.json`, add the following: 39 | ```json 40 | { 41 | "plugins": [ 42 | [ 43 | "rn-pendo-sdk", 44 | { 45 | "ios-scheme": "YOUR_IOS_SCHEME_ID", 46 | "android-scheme": "YOUR_ANDROID_SCHEME_ID" 47 | } 48 | ] 49 | ] 50 | } 51 | ``` 52 | This configuration enables Pendo to enter pair mode to tag Pages and Features. 53 | 54 | ## Step 3. Production bundle - modify Javascript minification 55 | In the `metro.config.js` file, add the following: 56 | ```javascript 57 | module.exports = { 58 | transformer: { 59 | // ... 60 | minifierConfig: { 61 | keep_classnames: true, // Preserve class names 62 | keep_fnames: true, // Preserve function names 63 | mangle: { 64 | keep_classnames: true, // Preserve class names 65 | keep_fnames: true, // Preserve function names 66 | } 67 | } 68 | } 69 | } 70 | ``` 71 | ## Step 4. Integration 72 | 73 | >[!NOTE] 74 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 75 | 76 | In the application main file (App.js/.ts/.tsx), add the following code: 77 | 78 | ```typescript 79 | import {PendoSDK, NavigationLibraryType} from "rn-pendo-sdk"; 80 | 81 | function initPendo() { 82 | const navigationOptions = { 'library': NavigationLibraryType.ReactNavigation }; 83 | const key = 'YOUR_API_KEY_HERE'; 84 | //note the following API will only setup initial configuration, to start collect analytics use start session 85 | PendoSDK.setup(key, navigationOptions); 86 | } 87 | 88 | initPendo(); 89 | ``` 90 | 91 | In the file where the `NavigationContainer` is created: 92 | import `WithPendoReactNavigation`: 93 | 94 | ```typescript 95 | import {WithPendoReactNavigation} from 'rn-pendo-sdk' 96 | ``` 97 | 98 | Wrap `NavigationContainer` with `WithPendoReactNavigation` HOC: 99 | 100 | ```typescript 101 | const PendoNavigationContainer = WithPendoReactNavigation(NavigationContainer); 102 | ``` 103 | 104 | replace `NavigationContainer` tag with `PendoNavigationContainer` tag: 105 | 106 | ```typescript 107 |
148 | As with other analytics tools, we are dependent on react-navigation [screen change callbacks](https://reactnavigation.org/docs/screen-tracking/) 149 | which means that codeless tracking analytics is available for screen components only. 150 | 151 | ## Developer documentation 152 | 153 | - API documentation available [here](/api-documentation/rn-apis.md). 154 | 155 | ## Troubleshooting 156 | 157 | - For technical issues, please [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues). 158 | - See our [release notes](https://developers.pendo.io/category/mobile-sdk/). 159 | - For additional documentation, visit our [Help Center](https://support.pendo.io/hc/en-us/categories/23324531103771-Mobile-implementation). 160 | -------------------------------------------------------------------------------- /ios/pnddocs/expo_router-ios.md: -------------------------------------------------------------------------------- 1 | # Expo iOS using Expo Router (**Beta**) 2 | 3 | >[!IMPORTANT] 4 | >- **Expo SDK** 41-54 using React Navigation 5+ is supported by our codeless solution. 5 | >- **Expo Go** is not supported. Pendo SDK has a native plugin that is not part of the Expo Go app. 6 | Pendo can *only* be used in development builds. For more about development builds read [adding custom native code with development builds](https://docs.expo.dev/workflow/customizing/). 7 | >- Support for React Native's New Architecture (Fabric) is available starting from version 3.7.2. 8 | 9 | >[!IMPORTANT] 10 | >Requirements: 11 | >- Deployment target of `iOS 11` or higher 12 | >- Swift Compatibility `5.7` or higher 13 | >- Xcode `14` or higher 14 | 15 | ## Step 1. Add Pendo dependency 16 | 17 | In the **root folder of your expo app**, add Pendo using one of your package managers: 18 | 19 | ```shell 20 | #example with npx expo 21 | npx expo install rn-pendo-sdk 22 | 23 | #example with npm 24 | npm install --save rn-pendo-sdk 25 | 26 | #example with yarn 27 | yarn add rn-pendo-sdk 28 | ``` 29 | 30 | ## Step 2. Project setup 31 | 32 | >[!NOTE] 33 | >Find your scheme ID in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 34 | 35 | In the `app.config.js` or `app.json`, add the following: 36 | ```json 37 | { 38 | "plugins": [ 39 | [ 40 | "rn-pendo-sdk", 41 | { 42 | "ios-scheme": "YOUR_IOS_SCHEME_ID", 43 | "android-scheme": "YOUR_ANDROID_SCHEME_ID" 44 | } 45 | ] 46 | ] 47 | } 48 | ``` 49 | This configuration enables Pendo to enter pair mode to tag Pages and Features. 50 | 51 | ## Step 3. Production bundle - modify Javascript minification 52 | In the `metro.config.js` file, add the following: 53 | ```javascript 54 | module.exports = { 55 | transformer: { 56 | // ... 57 | minifierConfig: { 58 | keep_classnames: true, // Preserve class names 59 | keep_fnames: true, // Preserve function names 60 | mangle: { 61 | keep_classnames: true, // Preserve class names 62 | keep_fnames: true, // Preserve function names 63 | } 64 | } 65 | } 66 | } 67 | ``` 68 | ## Step 4.Integration 69 | 70 | >[!NOTE] 71 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 72 | 73 | In the application main file (App.js/.ts/.tsx), add the following code: 74 | 75 | ```typescript 76 | import {PendoSDK, NavigationLibraryType} from "rn-pendo-sdk"; 77 | 78 | function initPendo() { 79 | const navigationOptions = {'library': NavigationLibraryType.ExpoRouter}; 80 | const key = 'YOUR_API_KEY_HERE'; 81 | //note the following API will only setup initial configuration, to start collect analytics use start session 82 | PendoSDK.setup(key, navigationOptions); 83 | } 84 | 85 | initPendo(); 86 | ``` 87 | In the file where your **Root Layout** is created 88 | import `WithPendoExpoRouter`, `usePathname` and `useGlobalSearchParams`: 89 | 90 | ```typescript 91 | import {WithPendoExpoRouter} from 'rn-pendo-sdk' 92 | import {useGlobalSearchParams, usePathname} from 'expo-router'; 93 | ``` 94 | 95 | Add the following code to the method building your **Root Layout** component. Make sure to pass **props** to your Root Layout method. 96 | 97 | ```typescript 98 | function RootLayout(props: any): ReactNode { 99 | ... 100 | let pathname = usePathname(); 101 | const params = useGlobalSearchParams(); 102 | 103 | useEffect(() => { 104 | props.onExpoRouterStateChange(pathname, params); 105 | }, [pathname, params, props]); 106 | ... 107 | } 108 | ``` 109 | Wrap your **Root Layout** component with **WithPendoExpoRouter**: 110 | ```typescript 111 | export default WithPendoExpoRouter(RootLayout); 112 | ``` 113 | Initialize Pendo Session where your visitor is being identified (e.g., login, register, etc.). 114 | ```typescript 115 | const visitorId = 'John Smith'; 116 | const accountId = 'Acme Inc.'; 117 | const visitorData = {'Age': 25, 'Country': 'USA'}; 118 | const accountData = {'Tier': 1, 'Size': 'Enterprise'}; 119 | 120 | PendoSDK.startSession(visitorId, accountId, visitorData, accountData); 121 | ``` 122 | 123 | >[!TIP] 124 | >To begin a session for an anonymous visitor, pass ```null``` or an empty string ```''``` as the Visitor ID. You can call the `startSession` API more than once and transition from an anonymous session to an identified session (or even switch between multiple identified sessions). 125 | 126 | If some of your own _custom_ react native components are not taggable because we can't detect it in the regular detection flow, 127 | you can try to add it manually to the scanning flow. To do this, add a prop `nativeID` to your component. 128 | For instance: 129 | ```typescript 130 |
151 | As with other analytics tools, we are dependent on react-navigation [screen change callbacks](https://reactnavigation.org/docs/screen-tracking/) 152 | which means that codeless tracking analytics is available for screen components only. 153 | 154 | ## Developer documentation 155 | 156 | - API documentation available [here](/api-documentation/rn-apis.md). 157 | 158 | ## Troubleshooting 159 | 160 | - For technical issues, please [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues). 161 | - See our [release notes](https://developers.pendo.io/category/mobile-sdk/). 162 | - For additional documentation, visit our [Help Center Mobile Section](https://support.pendo.io/hc/en-us/categories/4403654621851-Mobile). 163 | -------------------------------------------------------------------------------- /android/pnddocs/expo_router-android.md: -------------------------------------------------------------------------------- 1 | # Expo Android using Expo Router (**Beta**) 2 | 3 | >[!IMPORTANT] 4 | >- **Expo SDK** 41-54 using React Navigation 5+ is supported by our codeless solution. 5 | >- **Expo Go** is not supported. Pendo SDK has a native plugin that is not part of the Expo Go app. 6 | Pendo can *only* be used in development builds. For more about development builds read [adding custom native code with development builds](https://docs.expo.dev/workflow/customizing/). 7 | >- Support for React Native's New Architecture (Fabric) is available starting from version 3.7.2. 8 | 9 | >[!IMPORTANT] 10 | >Requirements: 11 | >- Android Gradle Plugin `8.0` or higher 12 | >- Kotlin version `1.9.0` or higher 13 | >- JAVA version `11` or higher 14 | >- minSdkVersion `21` or higher 15 | >- compileSDKVersion `35` or higher 16 | 17 | ## Step 1. Add Pendo dependency 18 | 19 | In the **root folder of your expo app**, add Pendo using one of your package managers: 20 | 21 | ```shell 22 | #example with npx expo 23 | npx expo install rn-pendo-sdk 24 | 25 | #example with npm 26 | npm install --save rn-pendo-sdk 27 | 28 | #example with yarn 29 | yarn add rn-pendo-sdk 30 | ``` 31 | 32 | ## Step 2. Project setup 33 | 34 | >[!NOTE] 35 | >Find your scheme ID in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 36 | 37 | In the `app.config.js` or `app.json`, add the following: 38 | ```json 39 | { 40 | "plugins": [ 41 | [ 42 | "rn-pendo-sdk", 43 | { 44 | "ios-scheme": "YOUR_IOS_SCHEME_ID", 45 | "android-scheme": "YOUR_ANDROID_SCHEME_ID" 46 | } 47 | ] 48 | ] 49 | } 50 | ``` 51 | This configuration enables Pendo to enter pair mode to tag Pages and Features. 52 | 53 | ## Step 3. Production bundle - modify Javascript minification 54 | In the `metro.config.js` file, add the following: 55 | ```javascript 56 | module.exports = { 57 | transformer: { 58 | // ... 59 | minifierConfig: { 60 | keep_classnames: true, // Preserve class names 61 | keep_fnames: true, // Preserve function names 62 | mangle: { 63 | keep_classnames: true, // Preserve class names 64 | keep_fnames: true, // Preserve function names 65 | } 66 | } 67 | } 68 | } 69 | ``` 70 | ## Step 4. Integration 71 | 72 | >[!NOTE] 73 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 74 | 75 | In the application main file (App.js/.ts/.tsx), add the following code: 76 | 77 | ```typescript 78 | import {PendoSDK, NavigationLibraryType} from "rn-pendo-sdk"; 79 | 80 | function initPendo() { 81 | const navigationOptions = {'library': NavigationLibraryType.ExpoRouter}; 82 | const key = 'YOUR_API_KEY_HERE'; 83 | //note the following API will only setup initial configuration, to start collect analytics use start session 84 | PendoSDK.setup(key, navigationOptions); 85 | } 86 | 87 | initPendo(); 88 | ``` 89 | 90 | In the file where your Root Layout is created 91 | import `WithPendoExpoRouter`, `usePathname` and `useGlobalSearchParams`: 92 | 93 | ```typescript 94 | import {WithPendoExpoRouter} from 'rn-pendo-sdk' 95 | import {useGlobalSearchParams, usePathname} from 'expo-router'; 96 | ``` 97 | 98 | Add the following code to your Root Layout component. Make sure to pass props to your Root Layout component. 99 | 100 | ```typescript 101 | function RootLayout(props: any): ReactNode { 102 | ... 103 | let pathname = usePathname(); 104 | const params = useGlobalSearchParams(); 105 | 106 | useEffect(() => { 107 | props.onExpoRouterStateChange(pathname, params); 108 | }, [pathname, params, props]); 109 | ... 110 | } 111 | ``` 112 | Wrap your Root Layout component with WithPendoExpoRouter: 113 | ```typescript 114 | export default WithPendoExpoRouter(RootLayout); 115 | ``` 116 | Initialize Pendo Session where your visitor is being identified (e.g., login, register, etc.). 117 | ```typescript 118 | const visitorId = 'John Smith'; 119 | const accountId = 'Acme Inc.'; 120 | const visitorData = {'Age': 25, 'Country': 'USA'}; 121 | const accountData = {'Tier': 1, 'Size': 'Enterprise'}; 122 | 123 | PendoSDK.startSession(visitorId, accountId, visitorData, accountData); 124 | ``` 125 | 126 | >[!TIP] 127 | >To begin a session for an anonymous visitor, pass ```null``` or an empty string ```''``` as the Visitor ID. You can call the `startSession` API more than once and transition from an anonymous session to an identified session (or even switch between multiple identified sessions). 128 | 129 | If some of your own _custom_ react native components are not taggable because we can't detect it in the regular detection flow, 130 | you can try to add it manually to the scanning flow. To do this, add a prop `nativeID` to your component. 131 | For instance: 132 | ```typescript 133 |
153 | As with other analytics tools, we are dependent on react-navigation [screen change callbacks](https://reactnavigation.org/docs/screen-tracking/) 154 | which means that codeless tracking analytics is available for screen components only. 155 | 156 | ## Developer documentation 157 | 158 | - API documentation available [here](/api-documentation/rn-apis.md). 159 | 160 | ## Troubleshooting 161 | 162 | - For technical issues, please [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues). 163 | - See our [release notes](https://developers.pendo.io/category/mobile-sdk/). 164 | - For additional documentation, visit our [Help Center Mobile Section](https://support.pendo.io/hc/en-us/categories/4403654621851-Mobile). 165 | -------------------------------------------------------------------------------- /migration-docs/react-native-2.x-to-3.x-migration.md: -------------------------------------------------------------------------------- 1 | # React Native migration from version 2.x to version 3.x 2 | 3 | 4 | Follow these instructions to resolve breaking changes in your app: 5 | 6 |
| Component / API | 10 |Instructions | 11 |
| withPendoRN | 17 |
18 |
19 | Use `WithPendoReactNavigation` instead of `withPendoRN` and remove any Pendo related code (ref, onStateChange and onReady implementations):
20 |
21 | 2.x (deprecated):
22 |
23 | ```javascript
24 | // in the file where the NavigationContainer is created
25 | import {withPendoRN} from 'rn-pendo-sdk'
26 |
27 | function RootNavigator(props) {
28 | const navigationRef = useRef();
29 | return (
30 | |
65 |
| initSDK | 71 |72 | 73 | Replace `initSDK` by calling `setup` and then `startSession`. 74 | 75 | 2.x (deprecated): 76 | 77 | ```javascript 78 | import { PendoSDK, NavigationLibraryType } from 'rn-pendo-sdk'; 79 | 80 | // only if using React Native Navigation 81 | import { Navigation } from "react-native-navigation"; 82 | 83 | // set session parameters 84 | const pendoParams = {'visitorId': 'someVisitorID', 85 | 'accountId': 'someAccountID', 86 | 'vistiorData': {'age': '25', 'country': 'USA'}, 87 | 'accountData': {'tier': '1', 'size': 'Enterprise'}}; 88 | 89 | // select the correct NavigationLibraryType according to your application 90 | const navigationOptions = {library: NavigationLibraryType.ReactNavigation}; 91 | const navigationOptions = {library: NavigationLibraryType.ReactNativeNavigation, navigation: Navigation}; 92 | const navigationOptions = {library: NavigationLibraryType.Other}; 93 | 94 | // establish connection to server and start a session 95 | PendoSDK.initSdk('someAppKey', 96 | pendoParams, 97 | navigationOptions); 98 | ``` 99 | 100 | 3.x: 101 | 102 | ```javascript 103 | import { PendoSDK, NavigationLibraryType } from 'rn-pendo-sdk'; 104 | 105 | // only if using React Native Navigation 106 | import { Navigation } from "react-native-navigation"; 107 | 108 | 109 | // select the correct NavigationLibraryType according to your application 110 | const navigationOptions = {library: NavigationLibraryType.ReactNavigation}; 111 | const navigationOptions = {library: NavigationLibraryType.ReactNativeNavigation, navigation: Navigation}; 112 | const navigationOptions = {library: NavigationLibraryType.Other}; 113 | 114 | // establish connection to server 115 | PendoSDK.setup('someAppKey', navigationOptions); 116 | 117 | // start a session 118 | PendoSDK.startSession('someVisitorID', 119 | 'someAccountID', 120 | {'age': '25', 'country': 'USA'}, 121 | {'tier': '1', 'size': 'Enterprise'}); 122 | ``` 123 | 124 | | 125 |
| initSDKWithoutVisitor | 131 |132 | 133 | Call `setup` instead of `initSDKWithoutVisitor`. 134 | 135 | 2.x (deprecated): 136 | 137 | ```javascript 138 | import { PendoSDK, NavigationLibraryType } from 'rn-pendo-sdk'; 139 | 140 | // only if using React Native Navigation 141 | import { Navigation } from "react-native-navigation"; 142 | 143 | 144 | // select the correct NavigationLibraryType according to your application 145 | const navigationOptions = {library: NavigationLibraryType.ReactNavigation}; 146 | const navigationOptions = {library: NavigationLibraryType.ReactNativeNavigation, navigation: Navigation}; 147 | const navigationOptions = {library: NavigationLibraryType.Other}; 148 | 149 | // establish connection to server 150 | PendoSDK.initSDKWithoutVisitor('someAppKey', navigationOptions); 151 | ``` 152 | 153 | 3.x: 154 | 155 | ```javascript 156 | import { PendoSDK, NavigationLibraryType } from 'rn-pendo-sdk'; 157 | 158 | // only if using React Native Navigation 159 | import { Navigation } from "react-native-navigation"; 160 | 161 | 162 | // select the correct NavigationLibraryType according to your application 163 | const navigationOptions = {library: NavigationLibraryType.ReactNavigation}; 164 | const navigationOptions = {library: NavigationLibraryType.ReactNativeNavigation, navigation: Navigation}; 165 | const navigationOptions = {library: NavigationLibraryType.Other}; 166 | 167 | // establish connection to server 168 | PendoSDK.setup('someAppKey', navigationOptions); 169 | ``` 170 | 171 | | 172 |
| clearVisitor | 178 |179 | 180 | Call `startSession` with `null` values instead of `clearVisitor`. 181 | 182 | 2.x (deprecated): 183 | 184 | ```javascript 185 | // start a session with an anonymous visitor 186 | PendoSDK.clearVisitor() 187 | ``` 188 | 189 | 3.x: 190 | 191 | ```javascript 192 | // start a session with an anonymous visitor 193 | PendoSDK.startSession(null, null, null, null); 194 | ``` 195 | 196 | | 197 |
| switchVisitor | 203 |204 | 205 | Call `startSession` with a new visitor or account id instead of `switchVisitor`. 206 | 207 | 2.x (deprecated): 208 | 209 | ```javascript 210 | PendoSDK.switchVisitor('someVisitorID', 211 | 'someAccountID', 212 | {'age': '25', 'country': 'USA'}, 213 | {'tier': '1', 'size': 'Enterprise'}); 214 | ``` 215 | 216 | 3.x: 217 | 218 | ```javascript 219 | PendoSDK.startSession('someVisitorID', 220 | 'someAccountID', 221 | {'age': '25', 'country': 'USA'}, 222 | {'tier': '1', 'size': 'Enterprise'}); 223 | ``` 224 | 225 | | 226 |
| setAccountId | 232 |233 | 234 | Call `startSession` with the new account id value instead of `setAccountId`. 235 | 236 | 2.x (deprecated): 237 | 238 | ```javascript 239 | PendoSDK.setAccountId('someAccountID'); 240 | ``` 241 | 242 | 3.x: 243 | 244 | ```javascript 245 | // start a new session passing in the new accountId 246 | PendoSDK.startSession('someVisitorID', 247 | 'someAccountID', 248 | {'age': '25', 'country': 'USA'}, 249 | {'tier': '1', 'size': 'Enterprise'}); 250 | ``` 251 | 252 | | 253 |
Follow our migration instructions to [upgrade from SDK 2.x to 3.0](/migration-docs/README.md) or refer to our [2.x integration instruction](https://github.com/pendo-io/pendo-mobile-sdk/blob/2.22.5/README.md). 5 | 6 | >[!IMPORTANT] 7 | >Requirements: 8 | >- .NET 8 - .NET 10 9 | >- Kotlin version 1.9.0 or higher 10 | 11 | ## Step 1. Install the Pendo SDK 12 | 13 | 1. In **Visual Studio** Solution Explorer, right-click on your shared project, then select "Add" - > "Add NuGet Packages…". 14 | 2. Search for: [**pendo-maui**](https://www.nuget.org/packages/pendo-maui) with latest version.
15 | 3. Press **Add Package**. 16 | 17 | 4. #### **Using Proguard / R8** 18 | 19 | - If you are using **ProGuard**, the rules that need to be added to ProGuard can be found here: [pendo-proguard.cfg](/android/pnddocs/pendo-proguard.cfg). 20 | 21 | 22 | - If you are using **ProGuard(D8/DX only)** to perform compile-time code optimization, and have `{Android SDK Location}/tools/proguard/proguard-android-optimize.txt`, add `!code/allocation/variable` to the `-optimizations` line in your `app/proguard-rules.pro` file. 23 | The optimizations line should look like this: 24 | `-optimizations *other optimizations*,!code/allocation/variable` 25 | 26 | ## Step 2. Integrate with the Pendo SDK 27 | 28 | >[!NOTE] 29 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 30 | 31 | 1. Open the shared project **App.xaml.cs** 32 | 33 | Add the following under 'using': 34 | 35 | ```c# 36 | using PendoMAUIPlugin; 37 | ``` 38 | 39 | In the **protected override void OnStart()** method, add the following code: 40 | 41 | ```c# 42 | protected override void OnStart() 43 | { 44 | IPendoService pendo = PendoServiceFactory.CreatePendoService(); 45 | 46 | /** if your app supports additional Platforms other than iOS and Android 47 | verify the Pendo instance is not null */ 48 | if (pendo != null) { 49 | string apiKey = "YOUR_API_KEY_HERE"; 50 | pendo.Setup(apiKey); 51 | } 52 | 53 | ... 54 | 55 | } 56 | ``` 57 | 58 | 2. Start the visitor's session in the Page where your visitor is being identified (e.g., login, register, etc.). 59 | 60 | ```c# 61 | ... 62 | using PendoMAUIPlugin; 63 | ... 64 | 65 | namespace ExampleApp 66 | { 67 | class ExampleLoginClass 68 | { 69 | 70 | public void ExampleMethod() 71 | { 72 | ... 73 | 74 | IPendoService pendo = PendoServiceFactory.CreatePendoService(); 75 | 76 | /** if your app supports additional Platforms other than iOS and Android 77 | verify the Pendo instance is not null */ 78 | if (pendo != null) { 79 | var visitorId = "VISITOR-UNIQUE-ID"; 80 | var accountId = "ACCOUNT-UNIQUE-ID"; 81 | 82 | var visitorData = new Dictionary
Follow our migration instructions to [upgrade from SDK 2.x to 3.0](/migration-docs/README.md) or refer to our [2.x integration instruction](https://github.com/pendo-io/pendo-mobile-sdk/blob/2.22.5/README.md). 6 | 7 | >[!IMPORTANT] 8 | >Requirements: 9 | >- .NET 8 - .NET 10 10 | 11 | ## Step 1. Install the Pendo SDK 12 | 13 | 1. In **Visual Studio** Solution Explorer, right-click on your shared project, then select "Add" - > "Add NuGet Packages…". 14 | 2. Search for: [**pendo-maui**](https://www.nuget.org/packages/pendo-maui) with latest version.
15 | 3. Press **Add Package**. 16 | 17 | 18 | ## Step 2. Integrate with the Pendo SDK 19 | 20 | >[!NOTE] 21 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 22 | 23 | 1. Open the shared project **App.xaml.cs**: 24 | 25 | Add the following under 'using': 26 | 27 | ```c# 28 | using PendoMAUIPlugin; 29 | ``` 30 | 31 | 32 | In the **protected override void OnStart()** method, add the following code: 33 | 34 | ```c# 35 | protected override void OnStart() 36 | { 37 | IPendoService pendo = PendoServiceFactory.CreatePendoService(); 38 | 39 | /** if your app supports additional Platforms other than iOS and Android 40 | verify the Pendo instance is not null */ 41 | if (pendo != null) { 42 | string apiKey = "YOUR_API_KEY_HERE"; 43 | pendo.Setup(apiKey); 44 | } 45 | 46 | ... 47 | 48 | } 49 | ``` 50 | 51 | 2. Start the visitor's Session in the Page where your visitor is being identified (e.g., login, register, etc.). 52 | 53 | ```c# 54 | using PendoMAUIPlugin; 55 | 56 | namespace ExampleApp 57 | { 58 | class ExampleLoginClass 59 | { 60 | 61 | public void MethodExample() 62 | { 63 | IPendoService pendo = PendoServiceFactory.CreatePendoService(); 64 | 65 | ... 66 | 67 | /** if your app supports additional Platforms other than iOS and Android 68 | verify the Pendo instance is not null */ 69 | if (pendo != null) { 70 | 71 | var visitorId = "VISITOR-UNIQUE-ID"; 72 | var accountId = "ACCOUNT-UNIQUE-ID"; 73 | 74 | var visitorData = new Dictionary
| Component / API | 16 |Instructions | 17 |
| Minimum JAVA version |
23 |
24 |
25 | 2.x (deprecated): `JAVA 8`
26 | 27 | 3.x: `JAVA 11` 28 | 29 | |
30 |
| Minimum Kotlin version |
36 |
37 |
38 | 2.x (deprecated): `1.7.20`
39 | 40 | 3.x: `1.9.0` 41 | 42 | |
43 |
| initSDK | 49 |50 | 51 | Replace `initSDK` by calling the `setup` API, followed by the `startSession` API. The `PendoInitParams` instance passed into `initSDK` no longer exists. The initialization parameters should be passed directly to the `setup` and `startSession` APIs. 52 | 53 | 2.x (deprecated): 54 | 55 | ```kotlin 56 | // set session parameters 57 | val pendoParams = Pendo.PendoInitParams() 58 | pendoParams.visitorId = "someVisitorID" 59 | pendoParams.accountId = "someAccountID" 60 | pendoParams.visitorData = mapOf("age" to 27, "country" to "USA") 61 | pendoParams.accountData = mapOf("tier" to 1, "size" to "Enterprise") 62 | 63 | // establish connection to server and start a session 64 | Pendo.initSDK( 65 | this, // Application or Activity 66 | "someAppKey", 67 | pendoParams 68 | ) 69 | ``` 70 | 71 | 3.x: 72 | 73 | ```kotlin 74 | // establish connection to server 75 | Pendo.setup( 76 | this, // Context 77 | "someAppKey", 78 | null, // PendoOptions 79 | null // PendoPhasesCallbackInterface 80 | ) 81 | 82 | // start a session 83 | Pendo.startSession( 84 | "someVisitorID", 85 | "someAccountID", 86 | mapOf("age" to 27, "country" to "USA"), 87 | mapOf("tier" to 1, "size" to "Enterprise") 88 | ) 89 | ``` 90 | 91 | | 92 |
| initSDKWithoutVisitor | 98 |99 | 100 | Call `setup` instead of `initSDKWithoutVisitor`. 101 | 102 | 2.x (deprecated): 103 | 104 | ```kotlin 105 | // establish connection to server 106 | Pendo.initSDKWithoutVisitor( 107 | this, // Application or Activity 108 | "someAppKey", 109 | null, // PendoOptions 110 | null // PendoPhasesCallbackInterface 111 | ) 112 | ``` 113 | 114 | 3.x: 115 | 116 | ```kotlin 117 | // establish connection to server 118 | Pendo.setup( 119 | this, // Context 120 | "someAppKey", 121 | null, // PendoOptions 122 | null // PendoPhasesCallbackInterface 123 | ) 124 | ``` 125 | 126 | | 127 |
| clearVisitor | 133 |134 | 135 | Call `startSession` with `null` values instead of `clearVisitor`. 136 | 137 | 2.x (deprecated): 138 | 139 | ```kotlin 140 | // start a session with an anonymous visitor 141 | Pendo.clearVisitor() 142 | ``` 143 | 144 | 3.x: 145 | 146 | ```kotlin 147 | // start a session with an anonymous visitor 148 | Pendo.startSession( 149 | null, // visitorId 150 | null, // accountId 151 | null, // visitorData 152 | null // accountData 153 | ) 154 | ``` 155 | 156 | | 157 |
| switchVisitor | 163 |164 | 165 | Call `startSession` with a new visitor or account id instead of `switchVisitor`. 166 | 167 | 2.x (deprecated): 168 | 169 | ```kotlin 170 | Pendo.switchVisitor( 171 | "someVisitorID", 172 | "someAccountID", 173 | mapOf("age" to 27, "country" to "USA"), 174 | mapOf("tier" to 1, "size" to "Enterprise") 175 | ) 176 | ``` 177 | 178 | 3.x: 179 | 180 | ```kotlin 181 | Pendo.startSession( 182 | "someVisitorID", 183 | "someAccountID", 184 | mapOf("age" to 27, "country" to "USA"), 185 | mapOf("tier" to 1, "size" to "Enterprise") 186 | ) 187 | ``` 188 | 189 | | 190 |
| setAccountId | 196 |197 | 198 | Call `startSession` with the new account id value instead of `setAccountId`. 199 | 200 | 2.x (deprecated): 201 | 202 | ```kotlin 203 | Pendo.setAccountId("someAccountID") 204 | ``` 205 | 206 | 3.x: 207 | 208 | ```kotlin 209 | // start a new session passing in the new accountId 210 | Pendo.startSession( 211 | "someVisitorID", 212 | "someAccountID", 213 | mapOf("age" to 27, "country" to "USA"), 214 | mapOf("tier" to 1, "size" to "Enterprise") 215 | ) 216 | ``` 217 | 218 | | 219 |
| pauseGuides (without arguments) |
225 | 226 | 227 | Pass a boolean value to `pauseGuides` to control dismissal of a guide if displayed when the API is invoked. By default, the deprecated API set the value to `true`. 228 | 229 | 2.x (deprecated): 230 | 231 | ```kotlin 232 | Pendo.pauseGuides() 233 | ``` 234 | 235 | 3.x: 236 | 237 | ```kotlin 238 | Pendo.pauseGuides(true) // true == dismiss any displayed guide 239 | ``` 240 | 241 | | 242 |
| isInitStarted callback | 248 |249 | 250 | The `onInitStarted` callback has been removed from the `PendoPhasesCallbackInterface`. 251 | 252 | 2.x (deprecated): 253 | 254 | ```kotlin 255 | class myPendoCallbackImplementation : PendoPhasesCallbackInterface { 256 | override fun onInitStarted() { ... } 257 | override fun onInitComplete() { ... } 258 | override fun onInitFailed() { ... } 259 | } 260 | ``` 261 | 262 | 3.x: 263 | 264 | ```kotlin 265 | class myPendoCallbackImplementation : PendoPhasesCallbackInterface { 266 | override fun onInitComplete() { ... } 267 | override fun onInitFailed() { ... } 268 | } 269 | ``` 270 | 271 | | 272 |
| Component / API | 284 |Instructions | 285 |
| startSession | 291 |292 | 293 | 2.x (deprecated): 294 | 295 | ```kotlin 296 | Pendo.startSession("someJWT", "someSigningKeyName") 297 | ``` 298 | 299 | 3.x: 300 | 301 | ```kotlin 302 | Pendo.jwt.startSession("someJWT", "someSigningKeyName") 303 | ``` 304 | 305 | | 306 |
| setVisitorData | 312 |313 | 314 | 2.x (deprecated): 315 | 316 | ```kotlin 317 | Pendo.setVisitorData("someJWT", "someSigningKeyName") 318 | ``` 319 | 320 | 3.x: 321 | 322 | ```kotlin 323 | Pendo.jwt.setVisitorData("someJWT", "someSigningKeyName") 324 | ``` 325 | 326 | | 327 |
| setAccountData | 333 |334 | 335 | 2.x (deprecated): 336 | 337 | ```kotlin 338 | Pendo.setAccountData("someJWT", "someSigningKeyName") 339 | ``` 340 | 341 | 3.x: 342 | 343 | ```kotlin 344 | Pendo.jwt.setAccountData("someJWT", "someSigningKeyName") 345 | ``` 346 | 347 | | 348 |
114 | 115 | 2. To enable pairing from the device: 116 | 117 | a. If using AppDelegate, add or modify the **openURL** function: 118 | 119 |
120 |
137 |
138 | Swift Instructions - Click to expand or collapse
121 | 122 | ```swift 123 | import Pendo 124 | 125 | ... 126 | 127 | func application(_ app: UIApplication,open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool { 128 | if url.scheme?.range(of: "pendo") != nil { 129 | PendoManager.shared().initWith(url) 130 | return true 131 | } 132 | // your code here... 133 | return true 134 | } 135 | ``` 136 |
139 | *)options {
145 | if ([[url scheme] containsString:@"pendo"]) {
146 | [[PendoManager sharedManager] initWithUrl:url];
147 | return YES;
148 | }
149 | // your code here ...
150 | return YES;
151 | }
152 | ```
153 |
154 |
155 | Objective-C Instructions - Click to expand or collapse
140 | 141 | ```objective-c 142 | @import Pendo; 143 | 144 | - (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary156 | 157 | b. If using SceneDelegate, add or modify the **openURLContexts** function: 158 | 159 |
160 | ) {
168 | if let url = URLContexts.first?.url, url.scheme?.range(of: "pendo") != nil {
169 | PendoManager.shared().initWith(url)
170 | }
171 | }
172 | ```
173 |
174 |
175 | Swift Instructions - Click to expand or collapse
161 | 162 | ```swift 163 | import Pendo 164 | 165 | ... 166 | 167 | func scene(_ scene: UIScene, openURLContexts URLContexts: Set
176 | *)URLContexts {
180 | NSURL *url = [[URLContexts allObjects] firstObject].URL;
181 | if ([[url scheme] containsString:@"pendo"]) {
182 | [[PendoManager sharedManager] initWithUrl:url];
183 | }
184 | // your code here ...
185 | }
186 | ```
187 |
188 |
189 | ## Step 4. Verify installation
190 |
191 | 1. Test using Xcode:
192 | Run the app while attached to Xcode.
193 | Review the Xcode console and look for the following message:
194 | `Pendo Mobile SDK was successfully integrated and connected to the server.`
195 | 2. In the Pendo UI, go to `Settings` > `Subscription Settings`.
196 | 3. Select your application from the list.
197 | 4. Select the `Install Settings tab` and follow the instructions under `Verify Your Installation` to ensure you have successfully integrated the Pendo SDK.
198 | 5. Confirm that you can see your app as `Integrated` under subscription settings.
199 |
200 | ## Developer documentation
201 |
202 | - API documentation available [here](/api-documentation/rn-apis.md).
203 | - Sample app with Pendo SDK integrated available here..
204 |
205 | ## Troubleshooting
206 |
207 | - For technical issues, please [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues).
208 | - See our [release notes](https://developers.pendo.io/category/mobile-sdk/).
209 | - For additional documentation, visit our [Help Center](https://support.pendo.io/hc/en-us/categories/23324531103771-Mobile-implementation).
210 |
--------------------------------------------------------------------------------
/ios/pnddocs/rn-ios.md:
--------------------------------------------------------------------------------
1 | # React Native iOS using React Navigation
2 |
3 | >[!NOTE]
4 | >**Expo SDK** 41-54 using React Navigation 5+ is supported. See dedicated [Expo integration instructions](/ios/pnddocs/expo_rn-ios.md).
5 |
6 | >[!IMPORTANT]
7 | >- We support a codeless solution for React Native 0.6-0.83 using react-navigation 5+.
8 | >- Support for React Native's New Architecture (Fabric) is available starting from version 3.7.2.
9 |
10 | >[!IMPORTANT]
11 | >Requirements:
12 | >- Deployment target of `iOS 11` or higher
13 | >- Swift Compatibility `5.7` or higher
14 | >- Xcode `14` or higher
15 |
16 | ## Step 1. Install the Pendo SDK
17 |
18 | 1. In the **root folder of your project**, add Pendo using one of your package managers:
19 |
20 | ```shell
21 | #example with npm
22 | npm install --save rn-pendo-sdk
23 |
24 | #example with yarn
25 | yarn add rn-pendo-sdk
26 | ```
27 |
28 | 2. In the **iOS folder**, run the following command:
29 |
30 | ```shell script
31 | pod install
32 | ```
33 |
34 | 3. **Modify Javascript minification**
35 |
36 | When bundling for production, React Native minifies class and function names to reduce the size of the bundle. This means there is no access to the original component names that are used for the codeless solution.
37 |
38 | In the application **metro.config.js**, add the following statements in the transformer:
39 |
40 | ```javascript
41 | module.exports = {
42 | transformer: {
43 | // ...
44 | minifierConfig: {
45 | keep_classnames: true, // Preserve class names
46 | keep_fnames: true, // Preserve function names
47 | mangle: {
48 | keep_classnames: true, // Preserve class names
49 | keep_fnames: true, // Preserve function names
50 | }
51 | }
52 | }
53 | }
54 | ```
55 |
56 | ## Step 2. Integrate with the Pendo SDK
57 |
58 | >[!NOTE]
59 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`.
60 | 1. In the application **main file (App.js/.ts/.tsx)**, add the following code:
61 |
62 | ```typescript
63 | import { PendoSDK, NavigationLibraryType } from 'rn-pendo-sdk';
64 |
65 | function initPendo() {
66 | const navigationOptions = {library: NavigationLibraryType.ReactNavigation};
67 | const pendoKey = 'YOUR_API_KEY_HERE';
68 | //note the following API will only setup initial configuration, to start collect analytics use startSession
69 | PendoSDK.setup(pendoKey, navigationOptions);
70 | }
71 | initPendo();
72 | ```
73 | 2. Initialize Pendo where your visitor is being identified (e.g., login, register, etc.).
74 |
75 | ```typescript
76 | const visitorId = 'VISITOR-UNIQUE-ID';
77 | const accountId = 'ACCOUNT-UNIQUE-ID';
78 | const visitorData = {'Age': '25', 'Country': 'USA'};
79 | const accountData = {'Tier': '1', 'Size': 'Enterprise'};
80 |
81 | PendoSDK.startSession(visitorId, accountId, visitorData, accountData);
82 | ```
83 |
84 | 3. In the file where the `NavigationContainer` is created.
85 |
86 | Import `WithPendoReactNavigation`:
87 |
88 | ```typescript
89 | import {WithPendoReactNavigation} from 'rn-pendo-sdk'
90 | ```
91 |
92 | Wrap `NavigationContainer` with `WithPendoReactNavigation` HOC
93 |
94 | ```typescript
95 | const PendoNavigationContainer = WithPendoReactNavigation(NavigationContainer);
96 | ```
97 |
98 | replace `NavigationContainer` tag with `PendoNavigationContainer` tag
99 |
100 | ```typescript
101 | Objective-C Instructions - Click to expand or collapse
177 | 178 | ```objectivec 179 | - (void)scene:(UIScene *)scene openURLContexts:(nonnull NSSet 131 | 132 | 2. To enable pairing from the device: 133 | 134 | a. If using AppDelegate, add or modify the **openURL** function: 135 | 136 |
137 |
154 |
155 | Swift Instructions - Click to expand or collapse
138 | 139 | ```swift 140 | import Pendo 141 | 142 | ... 143 | 144 | func application(_ app: UIApplication,open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool { 145 | if url.scheme?.range(of: "pendo") != nil { 146 | PendoManager.shared().initWith(url) 147 | return true 148 | } 149 | // your code here... 150 | return true 151 | } 152 | ``` 153 |
156 |
160 |
161 | - (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary *)options {
162 | if ([[url scheme] containsString:@"pendo"]) {
163 | [[PendoManager sharedManager] initWithUrl:url];
164 | return YES;
165 | }
166 | // your code here ...
167 | return YES;
168 | }
169 | ```
170 |
171 |
172 | Objective-C Instructions - Click to expand or collapse
157 | 158 | ```objective-c 159 | #import173 | 174 | b. If using SceneDelegate, add or modify the **openURLContexts** function: 175 | 176 |
177 | ) {
185 | if let url = URLContexts.first?.url, url.scheme?.range(of: "pendo") != nil {
186 | PendoManager.shared().initWith(url)
187 | }
188 | }
189 | ```
190 |
191 |
192 | Swift Instructions - Click to expand or collapse
178 | 179 | ```swift 180 | import Pendo 181 | 182 | ... 183 | 184 | func scene(_ scene: UIScene, openURLContexts URLContexts: Set
193 | *)URLContexts {
197 | NSURL *url = [[URLContexts allObjects] firstObject].URL;
198 | if ([[url scheme] containsString:@"pendo"]) {
199 | [[PendoManager sharedManager] initWithUrl:url];
200 | }
201 | // your code here ...
202 | }
203 | ```
204 |
205 |
206 |
207 | ## Step 4. Verify installation
208 |
209 | 1. Test using Xcode:
210 | Run the app while attached to Xcode.
211 | Review the Xcode console and look for the following message:
212 | `Pendo Mobile SDK was successfully integrated and connected to the server.`
213 | 2. In the Pendo UI, go to `Settings` > `Subscription Settings`.
214 | 3. Select your application from the list.
215 | 4. Select the `Install Settings tab` and follow the instructions under `Verify Your Installation` to ensure you have successfully integrated the Pendo SDK.
216 | 5. Confirm that you can see your app as `Integrated` under subscription settings.
217 |
218 |
219 | ## Developer documentation
220 |
221 | - API documentation available [here](/api-documentation/rn-apis.md).
222 | - Sample app with Pendo SDK integrated available here.
223 |
224 | ## Troubleshooting
225 |
226 | - For technical issues, please [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues).
227 | - See our [release notes](https://developers.pendo.io/category/mobile-sdk/).
228 | - For additional documentation, visit our [Help Center](https://support.pendo.io/hc/en-us/categories/23324531103771-Mobile-implementation).
229 |
--------------------------------------------------------------------------------
/migration-docs/ios-2.x-to-3.x-migration.md:
--------------------------------------------------------------------------------
1 | # Native iOS migration from version 2.x to version 3.x
2 |
3 | ## Table of contents:
4 | - [Instructions for SwiftUI beta SDK](#mandatory-migration-instructions-for-the-swiftui-beta-sdk)
5 | - [Instructions for all native iOS SDK integrations](#changes-relevant-to-all-native-ios-apps)
6 | - [Instructions for secure metadata sessions using JWT](#changes-relevant-to-secure-metadata-sessions-using-jwt)
7 |
8 | ## Mandatory migration instructions for the SwiftUI beta SDK
9 |
10 | Pendo’s SwiftUI support is GA and its library is now merged into the iOS native SDK. The SwiftUI beta integration is no longer in use. If using SwiftUI beta support, follow the instructions in the table to switch over to the iOS native SDK.
11 |
12 | Objective-C Instructions - Click to expand or collapse
194 | 195 | ```objectivec 196 | - (void)scene:(UIScene *)scene openURLContexts:(nonnull NSSet| Component / API | 15 |Instructions | 16 |
| Integration with Cocoapods | 22 |23 | 24 | In the podfile, replace `pod 'PendoSwiftUI'` with `pod 'Pendo'`. 25 | 26 | | 27 |
| Integration with SPM | 33 |34 | 35 | In the SPM, find the Pendo package and switch the Dependency Rule from `Branch` to `Up to Next Major Version`. 36 | | 37 |
| enableSwiftUI | 43 | 44 |45 | 46 | The `enableSwiftUI` method has been renamed to `pendoEnableSwiftUI`. 47 | 48 | 2.x (deprecated): 49 | 50 | ```swift 51 | someView.enableSwiftUI() 52 | ``` 53 | 3.0: 54 | 55 | ```swift 56 | someView.pendoEnableSwiftUI() 57 | ``` 58 | 59 | 3.1 (deprecated): 60 | 61 | The API has been deprecated and calling it will be ignored. The SDK automatically performs the logic removing the need to use this API. 62 | 63 | | 64 | 65 |
| enableClickAnalytics | 71 |72 | 73 | The `enableClickAnalytics` method has been renamed to `pendoRecognizeClickAnalytics`. 74 | 75 | 2.x (deprecated): 76 | 77 | ```swift 78 | someView.enableClickAnalytics() 79 | ``` 80 | 3.x: 81 | 82 | ```swift 83 | someView.pendoRecognizeClickAnalytics() 84 | ``` 85 | 86 | 87 | | 88 |
| Component / API | 100 |Instructions | 101 |
| Minimum deployment target |
107 |
108 |
109 | 2.x (deprecated):
110 | `iOS 9.0`
111 | 3.x: 112 | `iOS 11.0` 113 | |
114 |
| Minimum xCode version |
120 |
121 |
122 | 2.x (deprecated):
123 | `13`
124 | 3.x: 125 | `14` 126 | |
127 |
| Minimum Swift compatibility |
133 |
134 |
135 | 2.x (deprecated):
136 | `5.6`
137 | 3.x: 138 | `5.7` 139 | |
140 |
| initSDK | 146 |147 | 148 | Replace `initSDK` by calling the `setup` API, followed by the `startSession` API. The `PendoInitParams` instance passed into `initSDK` no longer exists. The initialization parameters should be passed directly to the `setup` and `startSession` APIs. 149 | 150 | 2.x (deprecated): 151 | 152 | ```swift 153 | // set session parameters 154 | let pendoInitParams = PendoInitParams() 155 | pendoInitParams.visitorId = "someVisitorID" 156 | pendoInitParams.accountId = "someAccountID" 157 | pendoInitParams.visitorData = ["age" : 27, "country" : "USA"] 158 | pendoInitParams.accountData = ["tier" : 1, "size" : "Enterprise"] 159 | 160 | // establish connection to server and start a session 161 | PendoManager.shared().initSDK("someAppKey", initParams: pendoInitParams) 162 | ``` 163 | 164 | 3.x: 165 | 166 | ```swift 167 | // establish connection to server 168 | PendoManager.shared().setup("someAppKey") 169 | 170 | // start a session 171 | PendoManager.shared().startSession("someVisitorID", 172 | accountId: "someAccountID", 173 | visitorData: ["age" : 27, "country" : "USA"], 174 | accountData: ["tier" : 1, "size" : "Enterprise"]) 175 | ``` 176 | 177 | | 178 |
| initSDKWithoutVisitor | 184 |185 | 186 | Call the `setup` API instead of `initSDKWithoutVisitor`. 187 | 188 | 2.x (deprecated): 189 | 190 | ```swift 191 | PendoManager.shared().initSDKWithoutVisitor("someAppKey", with: nil) 192 | ``` 193 | 3.x: 194 | 195 | ```swift 196 | PendoManager.shared().setup("someAppKey", with: nil) 197 | ``` 198 | 199 | | 200 |
| clearVisitor | 206 |207 | 208 | Call the `startSession` API with `nil` values instead of `clearVisitor`. 209 | 210 | 2.x (deprecated): 211 | 212 | ```swift 213 | // start a session with an anonymous visitor 214 | PendoManager.shared().clearVisitor() 215 | ``` 216 | 217 | 3.x: 218 | 219 | ```swift 220 | // start a session with an anonymous visitor 221 | PendoManager.shared().startSession(nil, 222 | accountId:nil, 223 | visitorData:nil, 224 | accountData:nil) 225 | ``` 226 | 227 | | 228 |
| switchVisitor | 234 |235 | 236 | Call the `startSession` API instead of `switchVisitor`. 237 | 238 | 2.x (deprecated): 239 | 240 | ```swift 241 | PendoManager.shared().switchVisitor("someVisitorID", 242 | accountId: "someAccountID", 243 | visitorData: ["age" : 27, "country" : "USA"], 244 | accountData: ["tier" : 1, "size" : "Enterprise"]) 245 | ``` 246 | 3.x: 247 | 248 | ```swift 249 | PendoManager.shared().startSession("someVisitorID", 250 | accountId: "someAccountID", 251 | visitorData: ["age" : 27, "country" : "USA"], 252 | accountData: ["tier" : 1, "size" : "Enterprise"]) 253 | ``` 254 | 255 | | 256 |
| pauseGuides (without arguments) |
262 | 263 | 264 | Pass a boolean value to `pauseGuides` to control dismissal of a guide if displayed when the API is invoked. By default, the deprecated API set the value to `true`. 265 | 266 | 2.x (deprecated): 267 | 268 | ```swift 269 | PendoManager.shared().pauseGuides() 270 | ``` 271 | 3.x: 272 | 273 | ```swift 274 | PendoManager.shared().pauseGuides(true) // true == dismiss any displayed guide 275 | ``` 276 | 277 | | 278 |
| enableClickAnalytics | 284 |285 | 286 | Call the `pendoRecognizeClickAnalytics` method on the UIView instance instead of passing the UIView instance as a parameter of `PendoManager.shared().enableClickAnalytics`. 287 | 288 | 2.x (deprecated): 289 | 290 | ```swift 291 | PendoManager.shared().enableClickAnalytics(someUIView) 292 | ``` 293 | 3.x: 294 | 295 | ```swift 296 | someUIView.pendoRecognizeClickAnalytics() 297 | ``` 298 | 299 | | 300 |
| accountId property setter | 306 |307 | 308 | Call `startSession` with the new account id value instead of setting the account id as a value of the `PendoManager.shared().accountId` property. 309 | 310 | 2.x (deprecated): 311 | 312 | ```swift 313 | PendoManager.shared().accountId = "someAccountId" 314 | ``` 315 | 3.x: 316 | 317 | ```swift 318 | PendoManager.shared().startSession("someVisitorID", 319 | accountId: "someAccountID", 320 | visitorData: ["age" : 27, "country" : "USA"], 321 | accountData: ["tier" : 1, "size" : "Enterprise"]) 322 | ``` 323 | 324 | | 325 |
| appkey property getter | 331 |332 | 333 | This property no longer exists. 334 | 335 | 2.x (deprecated): 336 | 337 | ```swift 338 | let appKey = PendoManager.shared().appKey 339 | ``` 340 | 341 | | 342 |
| Component / API | 354 |Instructions | 355 | 356 |
| startSession | 362 |363 | 364 | 2.x (deprecated): 365 | 366 | ```swift 367 | PendoManager.shared().startSession("someJWT", "someSigningKeyName") 368 | ``` 369 | 3.x: 370 | 371 | ```swift 372 | PendoManager.shared().jwt.startSession("someJWT", "someSigningKeyName") 373 | ``` 374 | 375 | | 376 |
| setVisitorData | 382 |383 | 384 | 2.x (deprecated): 385 | 386 | ```swift 387 | PendoManager.shared().setVisitorData("someJWT", "someSigningKeyName") 388 | ``` 389 | 3.x: 390 | 391 | ```swift 392 | PendoManager.shared().jwt.setVisitorData("someJWT", "someSigningKeyName") 393 | ``` 394 | | 395 |
| setAccountData | 401 |402 | 403 | 2.x (deprecated): 404 | 405 | ```swift 406 | PendoManager.shared().setAccountData("someJWT", "someSigningKeyName") 407 | ``` 408 | 3.x: 409 | 410 | ```swift 411 | PendoManager.shared().jwt.setAccountData("someJWT", "someSigningKeyName") 412 | ``` 413 | | 414 |
Follow our migration instructions to [upgrade from SDK 2.x to 3.0](/migration-docs/README.md) or refer to our [2.x integration instructions](https://github.com/pendo-io/pendo-mobile-sdk/blob/2.22.5/README.md). 5 | 6 | >[!IMPORTANT] 7 | >**Jetpack Compose GA** is now available (SDK 3.7.0+), offering: 8 | >- Retroactive analytics 9 | >- Self-serve tagging 10 | >- Full guides support 11 | > 12 | > If your application already uses Pendo, please review and implement the additional steps outlined in [Step 3](#step-3-tracking-jetpack-compose) to enable Jetpack Compose support within your existing integration. 13 | 14 | >[!IMPORTANT] 15 | >Requirements: 16 | >- Android Gradle Plugin `8.0` or higher 17 | >- Kotlin version `1.9.0` or higher 18 | >- JAVA version `11` or higher 19 | >- minSdkVersion `21` or higher 20 | >- compileSDKVersion `35` or higher 21 | > 22 | > If using Jetpack Compose: 23 | >- androidx.compose.ui:ui `1.5.0` or higher 24 | 25 | ## Step 1. Install Pendo SDK 26 | 27 | 1. #### Add the Pendo repository to the app's build.gradle or to the settings.gradle if using dependencyResolutionManagement: 28 | 29 | ```java 30 | repositories { 31 | maven { 32 | url = uri("https://software.mobile.pendo.io/artifactory/androidx-release") 33 | } 34 | mavenCentral() 35 | } 36 | ``` 37 | 38 | 2. #### Add Pendo as a dependency to **android/build.gradle** file: 39 | 40 | ```shell 41 | dependencies { 42 | implementation group:'sdk.pendo.io' , name:'pendoIO', version:'3.9.+', changing:true 43 | } 44 | ``` 45 | 46 | 3. **Minimum and compile SDK versions**: 47 | 48 | If applicable, set your app to be compiled with **compileSdkVersion 35** or higher and **minSdkVersion 21** or higher: 49 | 50 | ```java 51 | android { 52 | minSdkVersion 21 53 | compileSdkVersion 35 54 | } 55 | ``` 56 | 57 | 4. #### Using ProGuard 58 | 59 | If you are using **ProGuard(D8/DX only)** to perform compile-time code optimization, and have `{Android SDK Location}/tools/proguard/proguard-android-optimize.txt`, add `!code/allocation/variable` to the `-optimizations` line in your `app/proguard-rules.pro` file. The optimizations line should look like this: 60 | `-optimizations *other optimizations*,!code/allocation/variable` 61 | 62 | ## Step 2. Integrate with the Pendo SDK 63 | 64 | >[!NOTE] 65 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 66 | 67 | 1. Set up Pendo in the **Application class**. 68 | 69 | The following code is required in the **onCreate** method: 70 | 71 | ```kotlin 72 | import sdk.pendo.io.*; 73 | 74 | val pendoApiKey = "YOUR_API_KEY_HERE" 75 | 76 | Pendo.setup( 77 | this, 78 | pendoApiKey, 79 | null, // PendoOptions (use only if instructed by Pendo support) 80 | null // PendoPhasesCallbackInterface (Optional) 81 | ) 82 | ``` 83 | 84 | 2. Initialize Pendo in the **Activity/fragment** where your visitor is being identified. 85 | 86 | ```kotlin 87 | val visitorId = "VISITOR-UNIQUE-ID" 88 | val accountId = "ACCOUNT-UNIQUE-ID" 89 | val visitorData = mapOf("age" to 27, "country" to "USA") 90 | val accountData = mapOf("Tier" to 1, "Size" to "Enterprise") 91 | 92 | Pendo.startSession( 93 | visitorId, 94 | accountId, 95 | visitorData, 96 | accountData 97 | ); 98 | ``` 99 | 100 | **visitorId**: a user identifier (e.g., John Smith) 101 | **visitorData**: the user metadata (e.g., email, phone, country, etc.) 102 | **accountId**: an affiliation of the user to a specific company or group (e.g., Acme inc.) 103 | **accountData** : the account metadata (e.g., tier, level, ARR, etc.) 104 | 105 | This code ends the previous mobile session (if applicable), starts a new mobile session, and retrieves all guides based on the provided information. 106 | 107 | 108 | >[!TIP] 109 | >To begin a session for an anonymous visitor, pass ```null``` or an empty string ```""``` as the Visitor ID. You can call the `startSession` API more than once and transition from an anonymous session to an identified session (or even switch between multiple identified sessions). 110 | 111 | ## Step 3. Tracking Jetpack Compose 112 | 113 | 1. **Add Compose Navigation Support** 114 | 115 | If you are using a **Compose Navigation**, add the following as soon as possible, immediately after `rememberNavController` in your app. 116 | 117 | 118 | - This step is required for the SDK to recognize Compose Pages in your app. 119 | - Navigation is limited to `androidx.navigation:navigation-compose` navigation. 120 | 121 | 122 | ```kotlin 123 | val navHostController = rememberNavController() 124 | .... 125 | 126 | LifecycleResumeEffect(null) { 127 | Pendo.setComposeNavigationController(navHostController.navController) 128 | 129 | onPauseOrDispose { 130 | Pendo.setComposeNavigationController(null) 131 | } 132 | } 133 | ``` 134 | 135 | >[!TIP] 136 | >We strongly recommend calling the navigation with your navigation component before calling startSession to ensure the SDK uses the correct screen ID. 137 | 138 | 2. **Drawer or ModalBottomSheetLayout Support (Add if applicable)** 139 | 140 | Automatic detection of Compose Drawer or ModalBottomSheetLayout in your app requires these steps: 141 | 142 | If you are using **Compose Navigation** add ``Modifier.pendoStateModifier(componentState)`` to your Drawer's or ModalBottomSheetLayout's modifier where componentState is the drawerState or sheetState. 143 | 144 | **Important:** To detect the dismissal of these components using this modifier, you must **specifically update the state** (bottomSheetState or drawerState) when you don’t want Pendo to detect the Page anymore. 145 | 146 | ```kotlin 147 | ModalBottomSheetLayout( 148 | sheetState = sheetState, 149 | sheetContent = { 150 | // Content of the bottom sheet 151 | modifier = Modifier.pendoStateModifier(sheetState), 152 | } 153 | ) 154 | ... 155 | ``` 156 | 157 | 3. **(Optional) Implement pendoTag in Jetpack Compose** 158 | 159 | PendoTags serve multiple purposes in identifying and tracking UI elements: 160 | 161 | - **Unique Feature identification:** It provides a unique identifier for Features during the tagging process. 162 | - **Manually enable click tracking:** For Composables you want to track as clicks that Pendo doesn't automatically detect, add pendoTag. You can also set mergeDescendants to true (default is false) to provide more attributes for better identification. 163 | - **Tooltip support:** Apply pendoTag to non-clickable Composable components to enable the presentation of tooltips. 164 | 165 | To implement pendoTag, add the following modifier to your relevant Composable components: 166 | 167 | ```kotlin 168 | someComposableObject( 169 | modifier = Modifier 170 | .pendoTag(UNIQUE_IDENTIFIER) 171 | ) 172 | ``` 173 | 174 | >[!NOTE] 175 | >pendoTags are case-sensitive. 176 | 177 | ## Step 4. Connect mobile device for tagging and testing 178 | 179 | >[!NOTE] 180 | >Find your scheme ID in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 181 | 182 | This step enables Page tagging 183 | and guide testing capabilities. 184 | 185 | Add the following **activity** to the application **AndroidManifest.xml** in the `
5 | > All other APIs must be called after both the `setup` and `startSession` APIs, otherwise they will be ignored.
6 | >The `setDebugMode` API is the exception to that rule and may be called anywhere in the code. 7 | 8 | ### PendoSDK APIs 9 | [setup](#setup) ⇒ `void`
10 | [startSession](#startsession) ⇒ `void`
11 | [setVisitorData](#setvisitordata) ⇒ `void`
12 | [setAccountData](#setaccountdata) ⇒ `void`
13 | [endSession](#endsession) ⇒ `void`
14 | [track](#track) ⇒ `void`
15 | [pauseGuides](#pauseguides) ⇒ `void`
16 | [resumeGuides](#resumeguides) ⇒ `void`
17 | [dismissVisibleGuides](#dismissvisibleguides) ⇒ `void`
18 | [getDeviceId](#getdeviceid) ⇒ `String`
19 | [getVisitorId](#getvisitorid) ⇒ `String`
20 | [getAccountId](#getaccountid) ⇒ `String`
21 | [setDebugMode](#setdebugmode) ⇒ `void`
22 | 23 | ## PendoSDK APIs 24 | 25 | ### `setup` 26 | 27 | ```c# 28 | static Future
Details - Click to expand or collapse
34 | 35 |36 | 37 | Class: PendoSDK 38 |
Kind: static method 39 |
40 | Returns: void 41 |
42 | 43 | | Param | Type | Description | 44 | | :---: | :---: | :--- | 45 | | appKey | String | The App Key is listed in your Pendo Subscription Settings in App Details | 46 | | pendoOptions | Map
Details - Click to expand or collapse
70 | 71 |72 | 73 | 74 | Class: PendoSDK 75 |
Kind: static method 76 |
77 | Returns: void 78 |
79 | 80 | | Param | Type | Description | 81 | | :---: | :---: | :--- | 82 | | visitorId | String? | The session visitor ID. For an anonymous visitor set to `null` | 83 | | accountId | String? | The session account ID | 84 | | visitorData | Dictionary
Details - Click to expand or collapse
108 | 109 |110 | 111 | 112 | Class: PendoSDK 113 |
Kind: static method 114 |
115 | Returns: void 116 |
117 | 118 | | Param | Type | Description | 119 | | :---: | :---: | :--- | 120 | | visitorData | Map
Details - Click to expand or collapse
142 | 143 |144 | 145 | 146 | Class: PendoSDK 147 |
Kind: static method 148 |
149 | Returns: void 150 |
151 | 152 | | Param | Type | Description | 153 | | :---: | :---: | :--- | 154 | | accountData | Map
Details - Click to expand or collapse
181 | 182 |183 | 184 | 185 | Class: PendoSDK 186 |
Kind: static method 187 |
188 | Returns: void 189 |
190 | 191 | Example: 192 | 193 | ```c# 194 | await PendoSDK.endSession(); 195 | ``` 196 | 197 |
208 |
209 | 210 | Class: PendoSDK
211 | Kind: static method
212 | Returns: void
213 |
214 | 215 | | Param | Type | Description | 216 | | :---: | :---: | :--- | 217 | | event | String | The track event name | 218 | | properties | Map? | Additional metadata to be sent as part of the track event |
219 |
220 | Example:
221 |
222 | ```c#
223 | await PendoSDK.track('App Opened', {'Theme': 'Dark Mode'});
224 | ```
225 |
226 |
227 | ### `pauseGuides`
228 |
229 | ```c#
230 | static FutureDetails - Click to expand or collapse
209 | 210 | Class: PendoSDK
211 | Kind: static method
212 | Returns: void
213 |
214 | 215 | | Param | Type | Description | 216 | | :---: | :---: | :--- | 217 | | event | String | The track event name | 218 | | properties | Map
236 |
237 | Class: PendoSDK
238 | Kind: static method
239 | Returns: void
240 |
241 | 242 | | Param | Type | Description | 243 | | :---: | :---: | :--- | 244 | | dismissGuides | bool | Determines whether the displayed guide, if one is visible, is dismissed when pausing the display of the further guides | 245 | 246 | Example: 247 | 248 | ```c# 249 | await PendoSDK.pauseGuides(false); 250 | ``` 251 |
252 |
253 |
254 | ### `resumeGuides`
255 |
256 | ```c#
257 | static FutureDetails - Click to expand or collapse
237 | Class: PendoSDK
238 | Kind: static method
239 | Returns: void
240 |
241 | 242 | | Param | Type | Description | 243 | | :---: | :---: | :--- | 244 | | dismissGuides | bool | Determines whether the displayed guide, if one is visible, is dismissed when pausing the display of the further guides | 245 | 246 | Example: 247 | 248 | ```c# 249 | await PendoSDK.pauseGuides(false); 250 | ``` 251 |
263 |
265 | Class: PendoSDK
266 | Kind: static method
267 | Returns: void
268 |
269 | Example: 270 | 271 | ```c# 272 | await PendoSDK.resumeGuides(); 273 | ``` 274 |
275 |
276 | ### `dismissVisibleGuides`
277 |
278 | ```c#
279 | static FutureDetails - Click to expand or collapse
264 |265 | Class: PendoSDK
266 | Kind: static method
267 | Returns: void
268 |
269 | Example: 270 | 271 | ```c# 272 | await PendoSDK.resumeGuides(); 273 | ``` 274 |
285 |
286 | Class: PendoSDK
287 | Kind: static method
288 | Returns: void
289 |
290 | Example: 291 | 292 | ```c# 293 | await PendoSDK.dismissVisibleGuides(); 294 | ``` 295 |
296 |
297 | ### `getDeviceId`
298 |
299 | ```c#
300 | static FutureDetails - Click to expand or collapse
286 | Class: PendoSDK
287 | Kind: static method
288 | Returns: void
289 |
290 | Example: 291 | 292 | ```c# 293 | await PendoSDK.dismissVisibleGuides(); 294 | ``` 295 |
306 |
308 | Class: PendoSDK
309 | Kind: static method
310 | Returns: String
311 |
312 | Example: 313 | 314 | ```c# 315 | await PendoSDK.getDeviceId(); 316 | ``` 317 |
318 |
319 | ### `getVisitorId`
320 |
321 | ```c#
322 | static FutureDetails - Click to expand or collapse
307 |308 | Class: PendoSDK
309 | Kind: static method
310 | Returns: String
311 |
312 | Example: 313 | 314 | ```c# 315 | await PendoSDK.getDeviceId(); 316 | ``` 317 |
328 |
330 | Class: PendoSDK
331 | Kind: static method
332 | Returns: String
333 |
334 | Example: 335 | 336 | ```c# 337 | await PendoSDk.getVisitorId(); 338 | ``` 339 |
340 |
341 | ### `getAccountId`
342 |
343 | ```c#
344 | static FutureDetails - Click to expand or collapse
329 |330 | Class: PendoSDK
331 | Kind: static method
332 | Returns: String
333 |
334 | Example: 335 | 336 | ```c# 337 | await PendoSDk.getVisitorId(); 338 | ``` 339 |
350 |
351 | Class: PendoSDK
352 | Kind: static method
353 | Returns: String
354 |
355 | Example: 356 | 357 | ```c# 358 | await PendoSDK.getAccountId(); 359 | ``` 360 |
361 |
362 | ### `setDebugMode`
363 |
364 | ```c#
365 | static FutureDetails - Click to expand or collapse
351 | Class: PendoSDK
352 | Kind: static method
353 | Returns: String
354 |
355 | Example: 356 | 357 | ```c# 358 | await PendoSDK.getAccountId(); 359 | ``` 360 |
Details - Click to expand or collapse
373 | 374 |375 | 376 | Class: PendoSDK 377 |
Kind: static method 378 |
379 | Returns: void 380 |
381 | 382 | | Param | Type | Description | 383 | | :---: | :---: | :--- | 384 | | isDebugEnabled | bool | Set to `true` to enable debug logs, `false` to disable | 385 | 386 | 387 | Example: 388 | 389 | ```c# 390 | await PendoSDK.setDebugMode(true); 391 | await PendoSDK.setup("your.app.key", null); 392 | ``` 393 |
5 | >Migration from the track-event solution to the low-code solution: 6 | > 1. Refer to [Step 2](#step-2-pendo-sdk-integration) in the installation guide, and verify the addition of the navigationObserver and clickListener. 7 | > 2. The migration process will take up to 24 hours to complete and be reflected in Pendo, during the processing time, you will not be able to tag Pages and Features. 8 | 9 | >[!IMPORTANT] 10 | >Requirements: 11 | >- Flutter: ">=3.16.0" 12 | >- SDK: ">=3.2.0 < 4.0.0" 13 | > 14 | >Supported Navigation Libraries: 15 | > 16 | >- GoRouter 13.0 or higher 17 | >- AutoRoute 7.0 or higher 18 | 19 | ## Step 1. Add Pendo dependency 20 | In the root folder of your flutter app add the Pendo package: `flutter pub add pendo_sdk`. 21 | 22 | ## Step 2. Integrate with the Pendo SDK 23 | 24 | >[!NOTE] 25 | >Find your API key in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 26 | 27 | 1. For optimal integration place the following code at the beginning of your app's execution: 28 | ```dart 29 | import 'package:pendo_sdk/pendo_sdk.dart'; 30 | var pendoKey = 'YOUR_API_KEY_HERE'; 31 | await PendoSDK.setup(pendoKey); 32 | ``` 33 | 34 | 2. Initialize the Pendo Session where your visitor is being identified (e.g., login, register, etc.). 35 | ```dart 36 | import 'package:pendo_sdk/pendo_sdk.dart'; 37 | final String visitorId = 'John Smith'; 38 | final String accountId = 'Acme Inc.'; 39 | final dynamic visitorData = {'Age': '25', 'Country': 'USA'}; 40 | final dynamic accountData = {'Tier': '1', 'Size': 'Enterprise'}; 41 | 42 | await PendoSDK.startSession(visitorId, accountId, visitorData, accountData); 43 | ``` 44 | 45 | >[!TIP] 46 | >To begin a session for an anonymous visitor, pass ```null``` or an empty string ```''``` as the Visitor ID. You can call the `startSession` API more than once and transition from an anonymous session to an identified session (or even switch between multiple identified sessions). 47 | 48 | 3. Add Navigation Observers
49 | When using `Flutter Navigator API` add PendoNavigationObserver for each app Navigator: 50 | ```dart 51 | import 'package:pendo_sdk/pendo_sdk.dart'; 52 | // Observes the MaterialApp/CupertinoApp main Navigator 53 | return MaterialApp( 54 | ... 55 | navigatorObservers: [ 56 | PendoNavigationObserver() 57 | ],); 58 | 59 | // Observes the nested widget Navigator 60 | return Navigator( 61 | ... 62 | observers: [ 63 | PendoNavigationObserver() 64 | ],); 65 | ``` 66 | > [!TIP] 67 | > The Pendo SDK uses the `Route` name to uniquely identify each `Route`. Pendo highly recommends that you give a unique name to each route in the `RouteSettings`. The unique names must also be applied to the `showModalBottomSheet` api. 68 | 69 | **Navigation Types:**
70 | 71 | * **_GoRouter_** 72 | 73 | When using `GoRouter`, change the `setup` API call to include the correct navigation library, like so: 74 | ```dart 75 | PendoSDK.setup(pendoKey, navigationLibrary: NavigationLibrary.GoRouter); 76 | ``` 77 | When using `GoRouter`, apply the `addPendoListenerToDelegate()` to your `GoRouter` instance. 78 | Make sure to add it once (e.g., adding it in the build method will be less desired) 79 | ```dart 80 | import 'package:pendo_sdk/pendo_sdk.dart'; 81 | 82 | final GoRouter _router = GoRouter()..addPendoListenerToDelegate() 83 | 84 | class _AppState extends State
107 | Make sure to add it once (e.g., adding it in the build method will be less desired)
108 | 109 | ```dart 110 | import 'package:pendo_sdk/pendo_sdk.dart'; 111 | 112 | @AutoRouterConfig() 113 | class AppRouter extends RootStackRouter { 114 | @override 115 | List
135 | Wrap the main widget with a PendoActionListener in the root of the project: 136 | ```dart 137 | import 'package:pendo_sdk/pendo_sdk.dart'; 138 | 139 | Widget build(BuildContext context) { 140 | return PendoActionListener( // Use the PendoActionListener to track action clicks 141 | child: MaterialApp( 142 | title: 'Title', 143 | home: Provider( 144 | create: (context) => MyHomePageStore()..initList(), 145 | child: MyHomePage(title: Strings.appName), 146 | ), 147 | navigatorObservers: [PendoNavigationObserver()], // Use Pendo Observer to track the Navigator stack transitions 148 | ); 149 | ) 150 | } 151 | ``` 152 | 153 | > [!TIP] 154 | > You can use track events to programmatically notify Pendo of custom events of interest:
155 | 156 | ```dart 157 | import 'package:pendo_sdk/pendo_sdk.dart'; 158 | await PendoSDK.track('name', { 'firstProperty': 'firstPropertyValue', 'secondProperty': 'secondPropertyValue'}); 159 | ``` 160 | 161 | ## Step 3. Mobile device connectivity and testing 162 | 163 | >[!NOTE] 164 | > Find your scheme ID in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 165 | 166 | These steps enable guide testing capabilities. 167 | 168 | 1. **Add Pendo URL scheme to **info.plist** file:** 169 | 170 | Under App Target > Info > URL Types, create a new URL by clicking the + button. 171 | Set **Identifier** to pendo-pairing or any name of your choosing. 172 | Set **URL Scheme** to `YOUR_SCHEME_ID_HERE`. 173 | 174 |
175 |
176 | 2. **To enable pairing from the device:**
177 |
178 | In the AppDelegate file add or modify the **openURL** function:
179 |
180 |
181 |
199 |
200 | Swift Instructions - Click to expand or collapse
182 | 183 | ```swift 184 | import Pendo 185 | 186 | @UIApplicationMain 187 | class AppDelegate: FlutterAppDelegate { 188 | override func application(_ app: UIApplication,open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool { 189 | if url.scheme?.range(of: "pendo") != nil { 190 | PendoManager.shared().initWith(url) 191 | return true 192 | } 193 | // your code here... 194 | return true 195 | } 196 | } 197 | ``` 198 |
201 | *)options {
207 | if ([[url scheme] containsString:@"pendo"]) {
208 | [[PendoManager sharedManager] initWithUrl:url];
209 | return YES;
210 | }
211 | // your code here ...
212 | return YES;
213 | }
214 | ```
215 |
216 |
217 | ## Step 4. Verify installation
218 |
219 | 1. Test using Xcode:
220 | Run the app while attached to Xcode.
221 | Review the Xcode console and look for the following message:
222 | `Pendo Mobile SDK was successfully integrated and connected to the server.`
223 | 2. In the Pendo UI, go to `Settings` > `Subscription Settings`.
224 | 3. Select your application from the list.
225 | 4. Select the `Install Settings tab` and follow the instructions under `Verify Your Installation` to ensure you have successfully integrated the Pendo SDK.
226 | 5. Confirm that you can see your app as `Integrated` under subscription settings.
227 |
228 |
229 | ## Using custom navigation widgets
230 | `With the release of version 3.6.2 custom navigation widget support was added.`
231 |
232 | To integrate custom navigation widgets (e.g., TabBar, BottomNavigationBar, PageView), follow these steps:
233 |
234 | 1. Implement `PendoCustomNavigationWidget` in your `StatefulWidget` class.
235 |
236 | 2. Implement `PendoNavigationState` in the corresponding state class.
237 |
238 | 3. Override `getPendoCustomNavigationInfo()` to provide details about the current navigation state.
239 |
240 | Example:
241 |
242 | ```dart
243 | class CUSTOM_STATEFULL_WIDGET extends StatefulWidget implements PendoCustomNavigationWidget { // Added for Pendo Support
244 | ...
245 | }
246 |
247 | class _CUSTOM_STATEFULL_WIDGET_STATE extends StateObjective-C Instructions - Click to expand or collapse
202 | 203 | ```objectivec 204 | @import Pendo; 205 | //your code 206 | - (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary5 | >Migration from the track-event solution to the low-code solution: 6 | > 1. Refer to [Step 2](#step-2-pendo-sdk-integration) in the installation guide, and verify the addition of the navigationObserver and clickListener. 7 | > 2. The migration process will take up to 24 hours to complete and be reflected in Pendo, during the processing time, you will not be able to tag Pages and Features. 8 | 9 | >[!IMPORTANT] 10 | >Requirements: 11 | >- Flutter: ">=3.16.0" 12 | >- SDK: ">=3.2.0 < 4.0.0" 13 | >- Android Gradle Plugin `8.0` or higher 14 | >- Kotlin version `1.9.0` or higher 15 | >- JAVA version `11` or higher 16 | >- minSdkVersion `21` or higher 17 | >- compileSDKVersion `35` or higher 18 | > 19 | >Supported Navigation Libraries: 20 | > 21 | >- GoRouter 13.0 or higher 22 | >- AutoRoute 7.0 or higher 23 | 24 | ## Step 1. Install Pendo SDK 25 | 26 | 1. In the **application folder**, run the following command: 27 | 28 | ```shell 29 | flutter pub add pendo_sdk 30 | ``` 31 | 32 | 2. In the application **android/build.gradle** file: 33 | 34 | - **Add the Pendo Repository to the repositories section under the allprojects section or to the settings.gradle if using dependencyResolutionManagement:** 35 | ```java 36 | allprojects { 37 | repositories { 38 | maven { 39 | url = uri("https://software.mobile.pendo.io/artifactory/androidx-release") 40 | } 41 | mavenCentral() 42 | } 43 | ``` 44 | 45 | - Minimum SDK Version: 46 | If applicable, set your app to be **minSdkVersion 21** or higher: 47 | 48 | ```java 49 | android { 50 | minSdkVersion 21 51 | } 52 | ``` 53 | 54 | 55 | 56 | 3. In the application **AndroidManifest.xml** file: 57 | Add the following `
109 | When using `Flutter Navigator API` add PendoNavigationObserver for each app Navigator: 110 | ```dart 111 | import 'package:pendo_sdk/pendo_sdk.dart'; 112 | // Observes the MaterialApp/CupertinoApp main Navigator 113 | return MaterialApp( 114 | ... 115 | navigatorObservers: [ 116 | PendoNavigationObserver() 117 | ],); 118 | 119 | // Observes the nested widget Navigator 120 | return Navigator( 121 | ... 122 | observers: [ 123 | PendoNavigationObserver() 124 | ],); 125 | ``` 126 | > [!TIP] 127 | > The Pendo SDK uses the `Route` name to uniquely identify each `Route`. Pendo highly recommends that you give a unique name to each route in the `RouteSettings`. The unique names must also be applied to the `showModalBottomSheet` api. 128 | 129 | **Navigation Types:**
130 | 131 | * **_GoRouter_** 132 | 133 | When using `GoRouter`, change the `setup` API call to include the correct navigation library, like so: 134 | ```dart 135 | PendoSDK.setup(pendoKey, navigationLibrary: NavigationLibrary.GoRouter); 136 | ``` 137 | 138 | When using `GoRouter`, apply the `addPendoListenerToDelegate()` to your `GoRouter` instance.
139 | Make sure to add it once (e.g., adding it in the build method will be less desired)
140 | 141 | ```dart 142 | import 'package:pendo_sdk/pendo_sdk.dart'; 143 | 144 | final GoRouter _router = GoRouter()..addPendoListenerToDelegate() 145 | 146 | class _AppState extends State
169 | Make sure to add it once (e.g., adding it in the build method will be less desired)
170 | 171 | ```dart 172 | import 'package:pendo_sdk/pendo_sdk.dart'; 173 | 174 | @AutoRouterConfig() 175 | class AppRouter extends RootStackRouter { 176 | @override 177 | List
197 | Wrap the main widget with a PendoActionListener in the root of the project: 198 | ```dart 199 | import 'package:pendo_sdk/pendo_sdk.dart'; 200 | Widget build(BuildContext context) { 201 | return PendoActionListener( // Use the PendoActionListener to track action clicks 202 | child: MaterialApp( 203 | title: 'Title', 204 | home: Provider( 205 | create: (context) => MyHomePageStore()..initList(), 206 | child: MyHomePage(title: Strings.appName), 207 | ), 208 | navigatorObservers: [PendoNavigationObserver()], // Use Pendo Observer to track the Navigator stack transitions 209 | ); 210 | ) 211 | } 212 | ``` 213 | 214 | >[!TIP] 215 | >You can use track events to programmatically notify Pendo of custom events of interest: 216 | ```dart 217 | import 'package:pendo_sdk/pendo_sdk.dart'; 218 | await PendoSDK.track('name', { 'firstProperty': 'firstPropertyValue', 'secondProperty': 'secondPropertyValue'}); 219 | ``` 220 | 221 | ## Step 3. Mobile device connectivity for testing 222 | 223 | >[!NOTE] 224 | >Find your scheme ID in the Pendo UI under `Settings` > `Subscription settings` > select an app > `App Details`. 225 | 226 | This step enables guide testing capabilities. 227 | 228 | Add the following **activity** to the application **AndroidManifest.xml** in the `
5 | > All other APIs must be called after both the `Setup` and `StartSession` APIs, otherwise they will be ignored.
6 | >The `SetDebugMode` API is the exception to that rule and may be called anywhere in the code. 7 | 8 | ### IPendoInterface APIs 9 | [IPendoInterface](#ipendointerface) ⇒ `IPendoInterface`
10 | [Setup](#setup) ⇒ `void`
11 | [StartSession](#startsession) ⇒ `void`
12 | [SetVisitorData](#setvisitordata) ⇒ `void`
13 | [SetAccountData](#setaccountdata) ⇒ `void`
14 | [EndSession](#endsession) ⇒ `void`
15 | [Track](#track) ⇒ `void`
16 | [PauseGuides](#pauseguides) ⇒ `void`
17 | [ResumeGuides](#resumeguides) ⇒ `void`
18 | [DismissVisibleGuides](#dismissvisibleguides) ⇒ `void`
19 | [GetDeviceId](#getdeviceid) ⇒ `string`
20 | [GetVisitorId](#getvisitorid) ⇒ `string`
21 | [GetAccountId](#getaccountid) ⇒ `string`
22 | [SetDebugMode](#setdebugmode) ⇒ `void`
23 | [ScreenContentChanged](#screencontentchanged) ⇒ `void`
24 | 25 | ## IPendoInterface APIs 26 | 27 | ### `IPendoInterface` 28 | 29 | ```c# 30 | interface IPendoInterface 31 | ``` 32 | 33 | >The interface of the Pendo shared instance. 34 | 35 |
Details - Click to expand or collapse
36 | 37 |38 | 39 | Example: 40 | 41 | ```c# 42 | using PendoSDKXamarin; 43 | 44 | namespace ExampleApp 45 | { 46 | public partial class App : Application 47 | { 48 | private static IPendoInterface Pendo = DependencyService.Get
Details - Click to expand or collapse
66 | 67 |68 | 69 | Class: PendoInterface 70 |
Kind: class method 71 |
Returns: void 72 |
73 | 74 | | Param | Type | Description | 75 | |:------:|:------:|:-------------------------------------------------------------------------| 76 | | appKey | string | The App Key is listed in your Pendo Subscription Settings in App Details | 77 | 78 |
79 | Example: 80 | 81 | ```c# 82 | Pendo.Setup("your.app.key"); 83 | ``` 84 |
Details - Click to expand or collapse
100 | 101 |102 | 103 | Class: PendoInterface 104 |
Kind: class method 105 |
Returns: void 106 |
107 | 108 | | Param | Type | Description | 109 | |:-----------:|:--------------------------:|:---------------------------------------------------------------| 110 | | visitorId | string | The session visitor ID. For an anonymous visitor set to `null` | 111 | | accountId | string | The session account ID | 112 | | visitorData | Dictionary
116 | Example: 117 | 118 | ```c# 119 | var visitorData = new Dictionary
Details - Click to expand or collapse
145 | 146 |147 | 148 | 149 | Class: PendoInterface 150 |
Kind: class method 151 |
Returns: void 152 |
153 | 154 | | Param | Type | Description | 155 | |:-----------:|:--------------------------:|:-----------------------------------| 156 | | visitorData | Dictionary
159 | Example: 160 | 161 | ```c# 162 | var visitorData = new Dictionary
Details - Click to expand or collapse
183 | 184 |185 | 186 | 187 | Class: PendoInterface 188 |
Kind: class method 189 |
Returns: void 190 |
191 | 192 | | Param | Type | Description | 193 | |:-----------:|:--------------------------:|:-----------------------------------| 194 | | accountData | Dictionary
197 | Example: 198 | 199 | ```c# 200 | var accountData = new Dictionary
Details - Click to expand or collapse
225 | 226 |227 | 228 | 229 | Class: PendoInterface 230 |
Kind: class method 231 |
Returns: void 232 |
233 |
234 | Example: 235 | 236 | ```c# 237 | Pendo.EndSession(); 238 | ``` 239 | 240 |
252 |
253 | 254 | Class: PendoInterface 255 |
Kind: class method 256 |
Returns: void 257 |
258 | 259 | | Param | Type | Description | 260 | |:----------:|:--------------------------:|:----------------------------------------------------------| 261 | | eventName | string | The track event name | 262 | | properties | Dictionary | Additional metadata to be sent as part of the track event |
263 |
264 |
265 | Example: 266 | 267 | ```c# 268 | var trackEventProperties = new Dictionary
269 | {
270 | { "Theme", "Dark Mode" },
271 | };
272 |
273 | Pendo.Track("App Opened", trackEventProperties);
274 | ```
275 |
276 |
277 | ### `PauseGuides`
278 |
279 | ```c#
280 | void PauseGuides(bool dismissGuides)
281 | ```
282 |
283 | >Pauses any guides from appearing during an active session. If the `DismissGuides` value is set to `true`, then any visible guide will be dismissed. Calling this API affects the current session. Starting a new session reverts this logic, enabling guides to be presented.
284 |
285 | Details - Click to expand or collapse
253 | 254 | Class: PendoInterface 255 |
Kind: class method 256 |
Returns: void 257 |
258 | 259 | | Param | Type | Description | 260 | |:----------:|:--------------------------:|:----------------------------------------------------------| 261 | | eventName | string | The track event name | 262 | | properties | Dictionary
265 | Example: 266 | 267 | ```c# 268 | var trackEventProperties = new Dictionary
286 |
287 | Class: PendoInterface 288 |
Kind: class method 289 |
Returns: void 290 |
291 | 292 | | Param | Type | Description | 293 | |:-------------:|:----:|:-----------------------------------------------------------------------------------------------------------------------| 294 | | dismissGuides | bool | Determines whether the displayed guide, if one is visible, is dismissed when pausing the display of the further guides | 295 | 296 | Example: 297 | 298 | ```c# 299 | Pendo.PauseGuides(false); 300 | ``` 301 |
302 |
303 |
304 | ### `ResumeGuides`
305 |
306 | ```c#
307 | void ResumeGuides()
308 | ```
309 |
310 | >Resumes displaying guides during the ongoing session. This API reverses the logic of the `PauseGuides` API.
311 |
312 | Details - Click to expand or collapse
287 | Class: PendoInterface 288 |
Kind: class method 289 |
Returns: void 290 |
291 | 292 | | Param | Type | Description | 293 | |:-------------:|:----:|:-----------------------------------------------------------------------------------------------------------------------| 294 | | dismissGuides | bool | Determines whether the displayed guide, if one is visible, is dismissed when pausing the display of the further guides | 295 | 296 | Example: 297 | 298 | ```c# 299 | Pendo.PauseGuides(false); 300 | ``` 301 |
313 |
314 | Class: PendoInterface 315 |
Kind: class method 316 |
Returns: void 317 |
318 |
319 | Example: 320 | 321 | ```c# 322 | Pendo.ResumeGuides(); 323 | ``` 324 |
325 |
326 | ### `DismissVisibleGuides`
327 |
328 | ```c#
329 | void DismissVisibleGuides()
330 | ```
331 |
332 | >Dismisses any visible guide.
333 |
334 | Details - Click to expand or collapse
314 | Class: PendoInterface 315 |
Kind: class method 316 |
Returns: void 317 |
318 |
319 | Example: 320 | 321 | ```c# 322 | Pendo.ResumeGuides(); 323 | ``` 324 |
335 |
336 | Class: PendoInterface 337 |
Kind: class method 338 |
Returns: void 339 |
340 |
341 | Example: 342 | 343 | ```c# 344 | Pendo.DismissVisibleGuides(); 345 | ``` 346 |
347 |
348 | ### `GetDeviceId`
349 |
350 | ```c#
351 | string GetDeviceId()
352 | ```
353 |
354 | >Returns the device's unique Pendo-generated ID.
355 |
356 | Details - Click to expand or collapse
336 | Class: PendoInterface 337 |
Kind: class method 338 |
Returns: void 339 |
340 |
341 | Example: 342 | 343 | ```c# 344 | Pendo.DismissVisibleGuides(); 345 | ``` 346 |
357 |
358 | Class: PendoInterface 359 |
Kind: class method 360 |
Returns: string 361 |
362 |
363 | Example: 364 | 365 | ```c# 366 | Pendo.GetDeviceId(); 367 | ``` 368 |
369 |
370 | ### `GetVisitorId`
371 |
372 | ```c#
373 | string GetVisitorId()
374 | ```
375 |
376 | >Returns the ID of the visitor in the active session.
377 |
378 | Details - Click to expand or collapse
358 | Class: PendoInterface 359 |
Kind: class method 360 |
Returns: string 361 |
362 |
363 | Example: 364 | 365 | ```c# 366 | Pendo.GetDeviceId(); 367 | ``` 368 |
379 |
380 | Class: PendoInterface 381 |
Kind: class method 382 |
Returns: string 383 |
384 |
385 | Example: 386 | 387 | ```c# 388 | Pendo.GetVisitorId(); 389 | ``` 390 |
391 |
392 | ### `GetAccountId`
393 |
394 | ```c#
395 | string GetAccountId()
396 | ```
397 |
398 | >Returns the ID of the account in the active session.
399 |
400 | Details - Click to expand or collapse
380 | Class: PendoInterface 381 |
Kind: class method 382 |
Returns: string 383 |
384 |
385 | Example: 386 | 387 | ```c# 388 | Pendo.GetVisitorId(); 389 | ``` 390 |
401 |
402 | Class: PendoInterface 403 |
Kind: class method 404 |
Returns: string 405 |
406 |
407 | Example: 408 | 409 | ```c# 410 | Pendo.GetAccountId(); 411 | ``` 412 |
413 |
414 | ### `SetDebugMode`
415 |
416 | ```c#
417 | void SetDebugMode(bool isDebugEnabled)
418 | ```
419 |
420 | >Enable/disable debug logs from Pendo SDK. To debug the Pendo SDK we recommend calling this API before calling the setup API.
421 |
422 | >Debug logs are turned off by default. Releasing your production app with the debug logs enabled is not recommended and may have performance repercussions on your app.
423 |
424 | Details - Click to expand or collapse
402 | Class: PendoInterface 403 |
Kind: class method 404 |
Returns: string 405 |
406 |
407 | Example: 408 | 409 | ```c# 410 | Pendo.GetAccountId(); 411 | ``` 412 |
Details - Click to expand or collapse
425 | 426 |427 | 428 | Class: PendoInterface 429 |
Kind: class method 430 |
Returns: void 431 |
432 | 433 | | Param | Type | Description | 434 | |:--------------:|:----:|:-------------------------------------------------------| 435 | | isDebugEnabled | bool | Set to `true` to enable debug logs, `false` to disable | 436 | 437 |
438 | Example: 439 | 440 | ```c# 441 | Pendo.SetDebugMode(true); 442 | Pendo.Setup("your.app.key"); 443 | ``` 444 |
459 |
460 | Class: PendoInterface 461 |
Kind: class method 462 |
Returns: void 463 |
464 |
465 | Example: 466 | 467 | ```c# 468 | Pendo.ScreenContentChanged(); 469 | ``` 470 |
471 |
--------------------------------------------------------------------------------
/api-documentation/xamarin-maui-apis.md:
--------------------------------------------------------------------------------
1 | # MAUI public developer API documentation
2 |
3 | > [!IMPORTANT]
4 | >The `Setup` API must be called before the `StartSession` API. Details - Click to expand or collapse
460 | Class: PendoInterface 461 |
Kind: class method 462 |
Returns: void 463 |
464 |
465 | Example: 466 | 467 | ```c# 468 | Pendo.ScreenContentChanged(); 469 | ``` 470 |
5 | > All other APIs must be called after both the `Setup` and `StartSession` APIs, otherwise they will be ignored.
6 | >The `SetDebugMode` API is the exception to that rule and may be called anywhere in the code. 7 | 8 | ### IPendoInterface APIs 9 | [IPendoService](#ipendoservice) ⇒ `IPendoService`
10 | [Setup](#setup) ⇒ `void`
11 | [StartSession](#startsession) ⇒ `void`
12 | [SetVisitorData](#setvisitordata) ⇒ `void`
13 | [SetAccountData](#setaccountdata) ⇒ `void`
14 | [EndSession](#endsession) ⇒ `void`
15 | [Track](#track) ⇒ `void`
16 | [PauseGuides](#pauseguides) ⇒ `void`
17 | [ResumeGuides](#resumeguides) ⇒ `void`
18 | [DismissVisibleGuides](#dismissvisibleguides) ⇒ `void`
19 | [GetDeviceId](#getdeviceid) ⇒ `string`
20 | [GetVisitorId](#getvisitorid) ⇒ `string`
21 | [GetAccountId](#getaccountid) ⇒ `string`
22 | [SetDebugMode](#setdebugmode) ⇒ `void`
23 | [ScreenContentChanged](#screencontentchanged) ⇒ `void`
24 | 25 | ## IPendoInterface APIs 26 | 27 | ### `IPendoService` 28 | 29 | ```c# 30 | interface IPendoService 31 | ``` 32 | 33 | >The interface of the Pendo shared instance. 34 | 35 |
Details - Click to expand or collapse
36 | 37 |38 | 39 | Example: 40 | 41 | ```c# 42 | using PendoSDKXamarin; 43 | 44 | namespace ExampleApp 45 | { 46 | public partial class App : Application 47 | { 48 | IPendoService Pendo = PendoServiceFactory.CreatePendoService(); 49 | 50 | /** if your app supports additional Platforms other than iOS and Android 51 | verify the Pendo instance is not null */ 52 | 53 | if (pendo != null) { 54 | 55 | // pendo related code 56 | 57 | } 58 | 59 | // the rest of your code 60 | } 61 | } 62 | ``` 63 |
Details - Click to expand or collapse
74 | 75 |76 | Interface: IPendoService 77 |
Class: PendoAndroidService/PendoiOSService 78 |
Kind: class method 79 |
Returns: void 80 |
81 | 82 | | Param | Type | Description | 83 | |:------:|:------:|:-------------------------------------------------------------------------| 84 | | appKey | string | The App Key is listed in your Pendo Subscription Settings in App Details | 85 | 86 | Example: 87 | 88 | ```c# 89 | Pendo.Setup("your.app.key"); 90 | ``` 91 |
Details - Click to expand or collapse
107 | 108 |109 | 110 | Interface: IPendoService 111 |
Class: PendoAndroidService/PendoiOSService 112 |
Kind: class method 113 |
Returns: void 114 |
115 | 116 | | Param | Type | Description | 117 | |:-----------:|:--------------------------:|:---------------------------------------------------------------| 118 | | visitorId | string | The session visitor ID. For an anonymous visitor set to `null` | 119 | | accountId | string | The session account ID | 120 | | visitorData | Dictionary
Details - Click to expand or collapse
153 | 154 |155 | 156 | 157 | Interface: IPendoService 158 |
Class: PendoAndroidService/PendoiOSService 159 |
Kind: class method 160 |
Returns: void 161 |
162 | 163 | | Param | Type | Description | 164 | |:-----------:|:--------------------------:|:-----------------------------------| 165 | | visitorData | Dictionary
Details - Click to expand or collapse
192 | 193 |194 | 195 | 196 | Interface: IPendoService 197 |
Class: PendoAndroidService/PendoiOSService 198 |
Kind: class method 199 |
Returns: void 200 |
201 | 202 | | Param | Type | Description | 203 | |:-----------:|:--------------------------:|:-----------------------------------| 204 | | accountData | Dictionary
Details - Click to expand or collapse
235 | 236 |237 | 238 | 239 | Interface: IPendoService 240 |
Class: PendoAndroidService/PendoiOSService 241 |
Kind: class method 242 |
Returns: void 243 |
244 | 245 | Example: 246 | 247 | ```c# 248 | Pendo.EndSession(); 249 | ``` 250 | 251 |
263 |
264 | 265 | Interface: IPendoService 266 |
Class: PendoAndroidService/PendoiOSService 267 |
Kind: class method 268 |
Returns: void 269 |
270 | 271 | | Param | Type | Description | 272 | |:----------:|:--------------------------:|:----------------------------------------------------------| 273 | | eventName | string | The track event name | 274 | | properties | Dictionary | Additional metadata to be sent as part of the track event |
275 |
276 | Example:
277 |
278 | ```c#
279 | var trackEventProperties = new Dictionary
280 | {
281 | { "Theme", "Dark Mode" },
282 | };
283 |
284 | Pendo.Track("App Opened", trackEventProperties);
285 | ```
286 |
287 |
288 | ### `PauseGuides`
289 |
290 | ```c#
291 | void PauseGuides(bool dismissGuides)
292 | ```
293 |
294 | >Pauses any guides from appearing during an active session. If the `DismissGuides` value is set to `true`, then any visible guide will be dismissed. Calling this API affects the current session. Starting a new session reverts this logic, enabling guides to be presented.
295 |
296 | Details - Click to expand or collapse
264 | 265 | Interface: IPendoService 266 |
Class: PendoAndroidService/PendoiOSService 267 |
Kind: class method 268 |
Returns: void 269 |
270 | 271 | | Param | Type | Description | 272 | |:----------:|:--------------------------:|:----------------------------------------------------------| 273 | | eventName | string | The track event name | 274 | | properties | Dictionary
297 |
298 | 299 | Interface: IPendoService 300 |
Class: PendoAndroidService/PendoiOSService 301 |
Kind: class method 302 |
Returns: void 303 |
304 | 305 | | Param | Type | Description | 306 | |:-------------:|:----:|:------------------------------------------------------------------------------------------------------------------------| 307 | | dismissGuides | bool | Determines whether the displayed guide, if one is visible, is dismissed when pausing the display of the further guides | 308 | 309 | Example: 310 | 311 | ```c# 312 | Pendo.PauseGuides(false); 313 | ``` 314 |
315 |
316 |
317 | ### `ResumeGuides`
318 |
319 | ```c#
320 | void ResumeGuides()
321 | ```
322 |
323 | >Resumes displaying guides during the ongoing session. This API reverses the logic of the `PauseGuides` API.
324 |
325 | Details - Click to expand or collapse
298 | 299 | Interface: IPendoService 300 |
Class: PendoAndroidService/PendoiOSService 301 |
Kind: class method 302 |
Returns: void 303 |
304 | 305 | | Param | Type | Description | 306 | |:-------------:|:----:|:------------------------------------------------------------------------------------------------------------------------| 307 | | dismissGuides | bool | Determines whether the displayed guide, if one is visible, is dismissed when pausing the display of the further guides | 308 | 309 | Example: 310 | 311 | ```c# 312 | Pendo.PauseGuides(false); 313 | ``` 314 |
326 |
327 | Interface: IPendoService 328 |
Class: PendoAndroidService/PendoiOSService 329 |
Kind: class method 330 |
Returns: void 331 |
332 | 333 | Example: 334 | 335 | ```c# 336 | Pendo.ResumeGuides(); 337 | ``` 338 |
339 |
340 | ### `DismissVisibleGuides`
341 |
342 | ```c#
343 | void DismissVisibleGuides()
344 | ```
345 |
346 | >Dismisses any visible guide.
347 |
348 | Details - Click to expand or collapse
327 | Interface: IPendoService 328 |
Class: PendoAndroidService/PendoiOSService 329 |
Kind: class method 330 |
Returns: void 331 |
332 | 333 | Example: 334 | 335 | ```c# 336 | Pendo.ResumeGuides(); 337 | ``` 338 |
349 |
351 | Interface: IPendoService 352 |
Class: PendoAndroidService/PendoiOSService 353 |
Kind: class method 354 |
Returns: void 355 |
356 | Example: 357 | 358 | ```c# 359 | Pendo.DismissVisibleGuides(); 360 | ``` 361 |
362 |
363 | ### `GetDeviceId`
364 |
365 | ```c#
366 | string GetDeviceId()
367 | ```
368 |
369 | >Returns the device's unique Pendo-generated ID.
370 |
371 | Details
350 |351 | Interface: IPendoService 352 |
Class: PendoAndroidService/PendoiOSService 353 |
Kind: class method 354 |
Returns: void 355 |
356 | Example: 357 | 358 | ```c# 359 | Pendo.DismissVisibleGuides(); 360 | ``` 361 |
372 |
373 | Interface: IPendoService 374 |
Class: PendoAndroidService/PendoiOSService 375 |
Kind: class method 376 |
Returns: String 377 |
378 | Example: 379 | 380 | ```c# 381 | Pendo.GetDeviceId(); 382 | ``` 383 |
384 |
385 | ### `GetVisitorId`
386 |
387 | ```c#
388 | string GetVisitorId()
389 | ```
390 |
391 | >Returns the ID of the visitor in the active session.
392 |
393 | Details - Click to expand or collapse
373 | Interface: IPendoService 374 |
Class: PendoAndroidService/PendoiOSService 375 |
Kind: class method 376 |
Returns: String 377 |
378 | Example: 379 | 380 | ```c# 381 | Pendo.GetDeviceId(); 382 | ``` 383 |
394 |
395 | Interface: IPendoService 396 |
Class: PendoAndroidService/PendoiOSService 397 |
Kind: class method 398 |
Returns: string 399 |
400 | Example: 401 | 402 | ```c# 403 | Pendo.GetVisitorId(); 404 | ``` 405 |
406 |
407 | ### `GetAccountId`
408 |
409 | ```c#
410 | string GetAccountId()
411 | ```
412 |
413 | >Returns the ID of the account in the active session.
414 |
415 | Details - Click to expand or collapse
395 | Interface: IPendoService 396 |
Class: PendoAndroidService/PendoiOSService 397 |
Kind: class method 398 |
Returns: string 399 |
400 | Example: 401 | 402 | ```c# 403 | Pendo.GetVisitorId(); 404 | ``` 405 |
416 |
417 | Interface: IPendoService 418 |
Class: PendoAndroidService/PendoiOSService 419 |
Kind: class method 420 |
Returns: string 421 |
422 | Example: 423 | 424 | ```c# 425 | Pendo.GetAccountId(); 426 | ``` 427 |
428 |
429 | ### `SetDebugMode`
430 |
431 | ```c#
432 | void SetDebugMode(bool isDebugEnabled)
433 | ```
434 |
435 | >Enable/disable debug logs from Pendo SDK. To debug the Pendo SDK we recommend calling this API before calling the setup API.
436 |
437 | >Debug logs are turned off by default. Releasing your production app with the debug logs enabled is not recommended and may have performance repercussions on your app.
438 |
439 | Details - Click to expand or collapse
417 | Interface: IPendoService 418 |
Class: PendoAndroidService/PendoiOSService 419 |
Kind: class method 420 |
Returns: string 421 |
422 | Example: 423 | 424 | ```c# 425 | Pendo.GetAccountId(); 426 | ``` 427 |
Details - Click to expand or collapse
440 | 441 |442 | 443 | Interface: IPendoService 444 |
Class: PendoAndroidService/PendoiOSService 445 |
Kind: class method 446 |
Returns: void 447 |
448 | 449 | | Param | Type | Description | 450 | |:--------------:|:----:|:-------------------------------------------------------| 451 | | isDebugEnabled | bool | Set to `true` to enable debug logs, `false` to disable | 452 | 453 | 454 | Example: 455 | 456 | ```c# 457 | Pendo.SetDebugMode(true); 458 | Pendo.Setup("your.app.key"); 459 | ``` 460 |
475 |
476 | Interface: IPendoService 477 |
Class: PendoAndroidService/PendoiOSService 478 |
Kind: class method 479 |
Returns: void 480 |
481 | Example: 482 | 483 | ```c# 484 | Pendo.ScreenContentChanged(); 485 | ``` 486 |
487 |
--------------------------------------------------------------------------------
Details - Click to expand or collapse
476 | Interface: IPendoService 477 |
Class: PendoAndroidService/PendoiOSService 478 |
Kind: class method 479 |
Returns: void 480 |
481 | Example: 482 | 483 | ```c# 484 | Pendo.ScreenContentChanged(); 485 | ``` 486 |