Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GoalBackground Information

To add Mobile App Manager to your app code for customers who have been using iOS SDK versions prior to iOS SDK v4.0. If you are not already using an earlier version of the iOS SDK, see instead. 

SDK4 is a lightweight SDK which utilizes the latest Apple API .SDK 4 is compiteble from iOS 7 and above.

...

On SDK 4 we have exposed new APIs with backward compatibility with SDK 3 APIs with the below changes:

...

  • Inbox messages (Not relevant for DMC customers)
    • support of Appoxee default UI for Inbox
    has been removed and we provide instead a reference implementation.
    • was removed
    • As an alternative a reference UI implementation is provided in our example application (code API gitHub).
    • In addition, Instead of using AppoxeeMessage object, developer will need to use APXRichMessage object.
  • More Apps, User Feedback removed – SDK removed (Not relevant for DMC customers)– SDK 4 implemented an empty implementation of these features 
  • Custom Field – Custom Field – fetching a custom field will be from the device cache only (values will not be fetched from server. So when migrating, on getting a custom field which wasn’t set, a nil value will be returned).

Background Information

SDK4 is a newly designed SDK that supports iOS versions 7.0 to 9.0 (and above). Built in an asynchronous manner, modeled, it uses the latest API from Apple. It is easy to maintain, fully tested and highly dynamic. The main conceptual differences are: Synchronous vs Asynchronous and Unmodeled vs Modeled. The effect that the two main differences will have on our customers are divided into two:

1. Synchronous vs Asynchronous - New clients will not be affected, since their implementation will be asynchronous. Existing clients will have to undergo some code changes, varying in scale in their projects, depending on their implementation.

2. Unmodeled vs Modeled - All clients will not experience any changes.

Prerequisites

  • iOS: Add the Mobile Push SDK.
  • Get your SDK key from TeradataDeep-Linking - SDK 4 uses iOS URL schemes for deep-linking. As such please make sure you perform the following:
    • You must implement the URL schemes and register them (see apple documentation)
    • Test all Deep linking by entering the deep link in the browser on the device and make sure that the expected screen is showing in the app.

Procedure

Existing customers who will upgrade to the new SDK will have to perform the below steps

...

2. Import Statements. Replace #import "Appoxee.h" with #import <AppoxeeSDK/AppoxeeSDK.h>

3. For customers who are using Appoxee Inbox changes are required:

 - Customers which use the Appoxee Inbox UI - Need to use the reference Inbox UI implementation

 -  Instead of using AppoxeeMessage, developer will need to use APXRichMessage

4. SDK 4 uses iOS URL schemes for deep-linking.If you have not registered the deep-link URLs, you will need to register them in order for deep-linking to work (see apple documentation).

5. Follow Add the Mobile Push SDK for Appoxee Standalone

Optional Steps:

  1. Remove all frameworks which were required in SDK3 and are not required by SDK 4 :AudioToolbox.framework, QuartzCore.framework, CoreGraphics.framework, libxml2.dylib, AWSSQS.framework, AWSRuntime.framework
  2. Upgrade and use SDK 4 APIs. While SDK has backward compatibility with SDK 3 APIs, the APIs exposed on SDK 4 have additional capabilities including more sophisticated error handling.

...