Skip to content

Commit 954f89c

Browse files
authored
Merge pull request #195 from Iterable/MOB-871-table-of-contents
[MOB-871] Table of Contents added to docs
2 parents f27bac5 + 3f51eee commit 954f89c

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,26 @@
33
[![pod](https://badge.fury.io/co/Iterable-iOS-SDK.svg)](https://cocoapods.org/pods/Iterable-iOS-SDK)
44
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
55

6+
# Table of Contents
7+
- [Installing with a dependency manager](#installing-with-a-dependency-manager)
8+
- [Carthage](#carthage)
9+
- [CocoaPods](#cocoapods)
10+
- [Installing manually](#installing-manually)
11+
- [Migrating from a version prior to 6.1.0](#migrating-from-a-version-prior-to-610)
12+
- [Sample projects](#sample-projects)
13+
- [Configuring the SDK](#configuring-the-sdk)
14+
- [Using the SDK](#using-the-sdk)
15+
- [Push notifications](#push-notifications)
16+
- [Deep links](#deep-links)
17+
- [In-app messages](#in-app-messages)
18+
- [Mobile inbox](#mobile-inbox)
19+
- [Custom events](#custom-events)
20+
- [User fields](#user-fields)
21+
- [Uninstall tracking](#uninstall-tracking)
22+
- [Additional information](#additional-information)
23+
- [License](#license)
24+
- [Want to Contribute?](#want-to-contribute)
25+
626
# Iterable iOS SDK
727

828
The Iterable iOS SDK is a Swift implementation of an iOS client for Iterable, for iOS versions 9.0 and higher.
@@ -713,7 +733,7 @@ config.customActionDelegate = YourCustomActionDelegate()
713733

714734
To customize the time delay between successive in-app messages (default value of 30 seconds), set `IterableConfig.inAppDisplayInterval` to an appropriate value (in seconds).
715735

716-
### Mobile Inbox
736+
### Mobile inbox
717737

718738
Apps using version 6.2.0 and later of this SDK can save in-app messages to an inbox. This inbox displays a list of saved in-app messages and allows users to read and interact with them at their convenience. The SDK provides a default user interface for the inbox, and it can be customized to match your brand's styles.
719739

@@ -724,7 +744,7 @@ To configure an in-app message to use the inbox, marketers should:
724744
- Enable the **Show in Inbox** toggle in the in-app message's template
725745
- Choose whether or not to **Deliver Silently to Inbox** (so that the message does not display prominently when the device receives it, but can be viewed later by the user)
726746

727-
#### Mobile Inbox implementation guide
747+
#### Mobile inbox implementation guide
728748

729749
When implementing an inbox, you'll work primarily with the `IterableInboxNavigationViewController` class, a subclass of `UINavigationController`. This class automatically instantiates `IterableInboxViewController` as its root view controller.
730750

@@ -881,6 +901,8 @@ Iterable will track uninstalls with no additional work by you.
881901

882902
To do this, Iterable sends a silent push notification some time (currently, 12 hours) after a campaign has been sent. Based on this silent push notification, if Iterable receives feedback that the device token is no longer valid, it assigns an uninstall to the device based on the prior campaign. Similarly, if a "real" campaign uncovers an invalid device token, it will also check for a prior (within 12 hours) campaign to mark as the cause for the uninstall. If there was no recent campaign, Iterable still tracks the uninstall, but does not attribute it to a campaign.
883903

904+
NOTE: Currently, Apple has changed the way device tokens expire, so they may take up to 8 days to detect if they are invalid. This does mean that uninstall tracking may not be accurately attributable to campaigns sent within that period of time.
905+
884906
## Additional information
885907

886908
For more information, take a look at:

0 commit comments

Comments
 (0)