|
5 | 5 |
|
6 | 6 | This is a repository of our open source iOS SDK, and the information presented here serves as a reference manual for our iOS SDK. See the table of contents below for a complete list of the content featured in this document. |
7 | 7 |
|
| 8 | +___ |
| 9 | + |
| 10 | +## iOS Reference |
| 11 | + |
| 12 | +1. External resources |
| 13 | + + [Full integration guide](https://dev.branch.io/getting-started/sdk-integration-guide/guide/ios/) |
| 14 | + + [Change log](https://github.com/BranchMetrics/ios-branch-deep-linking/blob/master/ChangeLog.md) |
| 15 | + + [Testing resources](https://dev.branch.io/getting-started/integration-testing/guide/ios/) |
| 16 | + + [Support portal](http://support.branch.io) |
| 17 | + + [Test app resources](#get-the-demo-app) |
| 18 | + |
| 19 | +2. Getting started |
| 20 | + + [Library installation](#installation) |
| 21 | + + [Register for Branch key](#register-your-app) |
| 22 | + + [Add your Branch key](#add-your-branch-key-to-your-project) |
| 23 | + + [Register a URI scheme](#register-a-uri-scheme-direct-deep-linking-optional-but-recommended) |
| 24 | + + [Support Universal Links](#support-universal-linking-ios-9) |
| 25 | + |
| 26 | +3. Branch general methods |
| 27 | + + [Get a Branch singleton](#get-a-singleton-branch-instance) |
| 28 | + + [Initialize Branch and register deep link router](#init-branch-session-and-deep-link-routing-function) |
| 29 | + + [Register view controller for auto deep linking](#register-a-deep-link-controller) |
| 30 | + + [Retrieve latest deep linking params](#retrieve-session-install-or-open-parameters) |
| 31 | + + [Retrieve the user's first deep linking params](#retrieve-install-install-only-parameters) |
| 32 | + + [Setting the user id for tracking influencers](#persistent-identities) |
| 33 | + + [Logging a user out](#logout) |
| 34 | + + [Tracking custom events](#register-custom-events) |
| 35 | + |
| 36 | +4. Branch Universal Objects |
| 37 | + + [Instantiate a Branch Universal Object](#branch-universal-object) |
| 38 | + + [Register views for content analytics](#register-views-for-content-analytics) |
| 39 | + + [List content on Spotlight](#list-content-on-spotlight) |
| 40 | + + [Configuring link properties](link-properties-parameters) |
| 41 | + + [Creating a short link referencing the object](#shortened-links) |
| 42 | + + [Triggering a share sheet to share a link](#uiactivityview-share-sheet) |
| 43 | + |
| 44 | +5. Referral rewards methods |
| 45 | + + [Get reward balance](#get-reward-balance) |
| 46 | + + [Redeem rewards](#redeem-all-or-some-of-the-reward-balance-store-state) |
| 47 | + + [Get credit history](#get-credit-history) |
| 48 | + |
| 49 | +___ |
| 50 | + |
8 | 51 | ## Get the Demo App |
9 | 52 |
|
10 | 53 | There's a full demo app embedded in this repository, but you can also check out our live demo: [Branch Monster Factory](https://itunes.apple.com/us/app/id917737838). We've [open sourced the Branchster's app](https://github.com/BranchMetrics/Branchster-iOS) as well if you're ready to dig in. |
11 | 54 |
|
12 | | -## Additional Resources |
13 | | -- [Integration guide](https://dev.branch.io/recipes/add_the_sdk/ios/) *Start Here* |
14 | | -- [Changelog](https://github.com/BranchMetrics/iOS-Deferred-Deep-Linking-SDK/blob/master/ChangeLog.md) |
15 | | -- [Testing](https://dev.branch.io/recipes/testing_your_integration/ios/) |
16 | | -- [Support portal, FAQ](http://support.branch.io) |
17 | | - |
18 | 55 | ## Installation |
19 | 56 |
|
20 | 57 | **The compiled iOS SDK footprint is 180kb** |
@@ -634,7 +671,7 @@ UIActivityView is the standard way of allowing users to share content from your |
634 | 671 |
|
635 | 672 | **Sample UIActivityView Share Sheet** |
636 | 673 |
|
637 | | - |
| 674 | + |
638 | 675 |
|
639 | 676 | The Branch iOS SDK includes a wrapper on the UIActivityViewController, that will generate a Branch short URL and automatically tag it with the channel the user selects (Facebook, Twitter, etc.). |
640 | 677 |
|
|
0 commit comments