Our documentation is changing, please click here to enjoy it!

Skip to end of metadata
Go to start of metadata

iOS SDK 6.2/6.3 to 6.4

 

Overview


SDK 6.4 adds iOS 12 features support. 

If you're using Swift, note that the option naming changed to allow for the new iOS 12 options addition:

is replaced by:


To start using the new features r
eplace:

    With:

      iOS SDK 6.0/6.1 to 6.2

      Overview

      SDK 6.2 adds GDPR support. Several new methods have been added that provide means of ensuring GDPR compliance. This also means that the SDK integration changed and needs to be updated in your application. 

      SDK start - new opt-in methods

      Replace:

        with:

          Replace:

            with:

              Once you have the opt-in information, call the following SDK methods:

                  These methods need to be called at every SDK start meaning that, once you have the opt-in information, you might start the SDK in the following way:

                    Make sure to delete the AccengageConfig.plist file if you're not using it to start the SDK

                    Nullability updates

                    While the SDK doesn't have the opt-in information or if the opt-in is disabled (the user decides to opt-out), its methods will return false, nil or 0. Nullability annotation of the SDK methods has been updated to reflect this. Please make sure that your application handles properly the values returned by the SDK.

                    Here are some examples (the following list is non exhaustive, please verify if the annotations changed for the methods used by your application):

                    iOS SDK 6.0 to 6.1

                    BMA4SInBox

                    Retrieve the inbox object

                    Use obtainMessagesWithCompletionHandler: instead of obtainMessagesForMembers:withHandler:

                     

                    iOS SDK 5.x to 6.0

                    Overview

                    Since the 6.0 the SDK is provided as a dynamic framework and as a result the minimum integration requirements have changed. Also, the integration has been significantly simplified and certain methods are now deprecated. 

                    Requirements

                    • Xcode 8 with iOS SDK 10
                    • Deployment target: iOS 8 or more recent

                    From  BM4ASConfig.plist to AccengageConfig.plist

                    A new configuration file have been introduced instead of BM4ASConfig.plist. Replace BM4ASConfig.plist with AccengageConfig.plist:

                    Import

                      From BMA4STracker To Accengage

                      The BMA4STracker object is deprecated and replaced by Accengage

                      Initialization

                        Tracking

                        Several tracking methods are now deprecated. 

                        Track event

                        Replace:

                          With:  

                            Track lead

                            Replace:

                              With:  

                                Track cart

                                Replace:

                                  With:  

                                    Track purchase

                                    Replace:

                                      With:  

                                        Track screen display/dismiss

                                        To track a screen display and dismiss, it's no longer necessary to inherit from BMA4SViewController class. You just need to import the Accengage header and and the accengageAlias in the viewDidLoad method:  

                                          If you prefer to keep tracking screens manually, you'll need to call the trackDisplay/trackDismiss method in viewDidAppear/viewDidDisappear method instead of broadcasting notifications.

                                          Replace:

                                            With:  

                                              Update device information

                                              Replace:

                                                With:  

                                                  Static lists

                                                  BMA4SList > ACCList

                                                  Replace: 

                                                    With:  

                                                      Subscribe

                                                      Replace: 

                                                        With:  

                                                          Unsubscribe

                                                          Replace:  

                                                            With:  

                                                              Subscription status

                                                              Replace: 

                                                                With:  

                                                                  Current subscriptions 

                                                                  Replace:  

                                                                    With:  

                                                                      Accengage Identifier

                                                                      Replace:

                                                                        With:  

                                                                          Suspend all services

                                                                          Replace:

                                                                            With:  

                                                                              Disable network calls

                                                                              Replace: 

                                                                                With:  

                                                                                  Enable logs 

                                                                                  Replace:

                                                                                    With:  

                                                                                      From BMA4SNotification to ACCPush

                                                                                      The BMA4SNotification object is deprecated and replaced by ACCPush

                                                                                      Shared instance

                                                                                      Replace:

                                                                                        With:  

                                                                                          Register for user notifications

                                                                                          In order to register for push notifications, you can now call the registerForUserNotificationsWithOptions method. This means that you're no longer required to maintain the registration code in your application, just call this method and the SDK will register the app for you. If you want to use custom categories for interactive notifications, you should call the setCustomCategories method first.

                                                                                          Replace:

                                                                                            With:  

                                                                                              Notification callbacks

                                                                                              Remove the following methods from application:didFinishLaunchingWithOptions: method of your appDelegate :

                                                                                                 

                                                                                                You're no longer required to implement the notification callbacks. The Accengage SDK is now able to intercept app delegate messages and forwarding them to your original app delegate.

                                                                                                This should be compatible with the majority of applications use cases, but if you prefer to disable this behavior, you can set automaticPushDelegateEnabled to NO in either your AccengageConfig.plist file or on a ACCConfig object passed to [Accengage startWithConfig:].

                                                                                                 

                                                                                                  If you choose to disable automatic integration, you will need to replace :

                                                                                                    With:  

                                                                                                      Accengage push delegate

                                                                                                      Use ACCPushDelegate instead of BMA4SNotificationDelegate

                                                                                                      Handle incoming URL schemes

                                                                                                      You're no longer required to call Accenage open url method. The Accengage SDK is now able to intercept app delegate messages and forwarding them to your original app delegate like for the notifications callbacks. All what you need to do is to add the following methods to your application delegate  

                                                                                                        But if you  set automaticPushDelegateEnabled to NO you will need to replace :

                                                                                                          With:  

                                                                                                             

                                                                                                             

                                                                                                            For the exhaustive list of deprecated methods, please check the public header files of the SDK.

                                                                                                             


                                                                                                            • No labels