|
1 | 1 | # branch-Android-sample-test-app |
| 2 | + |
2 | 3 | Sample Test App for Branch Android SDK |
| 4 | + |
| 5 | +## Purpose |
| 6 | + |
| 7 | +The purpose of this app is to assist developers integrating the Branch Android SDK. |
| 8 | +It provides simple use cases that integrate most of the Android Advanced Features found here: https://help.branch.io/developers-hub/docs/android-advanced-features |
| 9 | + |
| 10 | +### *Features Implemented* |
| 11 | +- Create a Content Reference |
| 12 | +- Create Deep Link |
| 13 | +- Share Deep Link |
| 14 | +- Read Deep Link |
| 15 | +- Create QR Code |
| 16 | +- Navigate to Content |
| 17 | +- Track Users |
| 18 | +- Track Events |
| 19 | +- Handle Links in Your Own App |
| 20 | +- Set Initialization Metadata |
| 21 | + |
| 22 | +### *How to Route to Content* |
| 23 | +1. Build and run the app on your device or emulator |
| 24 | +2. Click the share button on the top of the Home Page |
| 25 | +3. Send the link to Messages, or copy and paste it into a text editor |
| 26 | +4. Click on the Branch Link. The app should open and route to the page it was coded for. |
| 27 | +5. (Optional) Test again by modifying link information in the shareBranchLink() function |
| 28 | + |
| 29 | +## Home Page: |
| 30 | + |
| 31 | +- App Creates a Branch Link on App Load at the top of the screen |
| 32 | + |
| 33 | +- Send Branch Purchase Event, Add To Cart Event, and Change Branch Badge Event using the Buttons |
| 34 | + |
| 35 | +- Create a QR Code / Share Branch Link with Navigation Buttons |
| 36 | + |
| 37 | +- Share button creates a link that modifies the color block page |
| 38 | + |
| 39 | +- QR Code button dims screen. Click anywhere on screen to hide QR Code |
| 40 | + |
| 41 | +- Change Branch Badge button changes the badge to a version with opposite colors |
| 42 | + |
| 43 | +## Color Block Page: |
| 44 | + |
| 45 | +- Color block changes based on "color_block_key" parameter |
| 46 | + |
| 47 | +- Options for "color_block_key" parameter are "red", "green", "blue", “yellow”, and “white” |
| 48 | + |
| 49 | +- If one of the above 5 colors aren't selected, color block defaults to white |
| 50 | + |
| 51 | +## Read Deep Link Page: |
| 52 | + |
| 53 | +- Collects session parameters and stores them |
| 54 | + |
| 55 | +- If a Branch link is clicked to open the app, session parameters are modified to match link parameters. |
| 56 | + |
| 57 | +- Collects install parameters on download and stores them |
| 58 | + |
| 59 | +- Page is scrollable in case parameters are too long for the screen |
| 60 | + |
| 61 | +## Limitations |
| 62 | + |
| 63 | +- Code changes are needed to modify link data on QR Code, Share Sheet, and Generated Branch Link |
| 64 | + |
| 65 | +- Install Parameters are difficult to modify |
| 66 | + |
| 67 | +- “+branch_force_new_session” may be confusing to developers on first use |
0 commit comments