Skip to content

Commit d91f0f9

Browse files
Andy Scottjtreanor
authored andcommitted
Re-added legacy migration docs (#161)
* Re-added legacy migration docs * Re-added legacy migration docs
1 parent 9266f57 commit d91f0f9

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Intercom for iOS supports iOS 8.x and iOS 9.x.
1515
Add the Intercom pod into your Podfile and run `pod install`.
1616

1717
use_frameworks!
18-
18+
1919
target :YourTargetName do
2020
pod 'Intercom'
2121
end
@@ -46,7 +46,7 @@ To use the sample app:
4646
##Setup and Configuration
4747

4848
* Our [installation guide](https://docs.intercom.io/install-on-your-product-or-site/quick-install/install-intercom-on-your-ios-app) contains full setup and initialisation instructions.
49-
* Read ["Configuring Intercom for iOS"](https://docs.intercom.io/configure-intercom-for-your-product-or-site/configure-intercom-for-mobile/configuring-intercom-for-ios).
49+
* Read ["Configuring Intercom for iOS"](https://docs.intercom.io/configure-intercom-for-your-product-or-site/configure-intercom-for-mobile/configuring-intercom-for-ios).
5050
* Please contact us on [Intercom](https://intercom.io) with any questions you may have, we're only a message away!
5151

5252
## Upgrading to v3.0
@@ -60,3 +60,22 @@ Intercom for iOS has support for all these things. For full details please read
6060
## Xcode Documentation
6161

6262
This documentation provides integrated help in Xcode for all public APIs in Intercom for iOS. [Download the docset](https://github.com/intercom/intercom-ios/releases/tag/latest) from the latest release and Copy the content into `~/Library/Developer/Shared/Documentation/DocSets`.
63+
64+
## Migrating from legacy version of the SDK
65+
66+
To upgrade from SDK versions **older then version 2.2.4** there are some method changes that you may want to be aware of. See installation instructions at the top of this page for more information on how to install the new version of the SDK.
67+
68+
<table>
69+
<tr><th colspan="3" style="text-align:center;">iOS Method Name Changes</th></tr>
70+
<tr><td style="text-align:center; font-weight: bold; width: 33.3%;">Old Name</td><td style="text-align:center; font-weight: bold; width: 33.3%;">Type</td><td style="text-align:center; font-weight: bold; width: 33.3%;">New Name</td></tr>
71+
<tr><td colspan="3" style="text-align:center; font-weight: bold;">From SDK version 2.0.x</td></tr>
72+
<tr><td>beginSessionForUserWithUserId</td><td>Name change. Dropped block parameter.</td><td>registerUserWithUserId</td></tr>
73+
<tr><td>beginSessionForUserWithEmail</td><td>Name change. Dropped block parameter.</td><td>registerUserWithEmail</td></tr>
74+
<tr><td>beginSessionForAnonymousUserWithCompletion</td><td>Name change. Dropped block parameter.</td><td>registerUnidentifiedUser</td></tr>
75+
<tr><td>updateUserWithAttributes</td><td>Dropped block parameter.</td><td>n/a</td></tr>
76+
<tr><td>logEventWithName</td><td>Dropped block parameter.</td><td>n/a</td></tr>
77+
<tr><td colspan="3" style="text-align:center; font-weight: bold;">From SDK version 1.x.x</td></tr>
78+
<tr><td>beginSessionForUserWithUserId</td><td>Name change. Dropped block parameter.</td><td>registerUserWithUserId</td></tr>
79+
<tr><td>beginSessionForUserWithEmail</td><td>Name change. Dropped block parameter.</td><td>registerUserWithEmail</td></tr>
80+
<tr><td>updateAttributes</td><td>Name change. Dropped block parameter.</td><td>updateUserWithAttributes</td></tr>
81+
</table>

0 commit comments

Comments
 (0)