Last modified July 28, 2021 by Shelly Wolfe

iOS SDK upgrade guide

This guide provides information about how to upgrade to the latest Swrve iOS SDK. For information about the changes that have been made in each iOS SDK release, see iOS SDK release notes.

Upgrading via CocoaPods

If you’re upgrading via CocoaPods, ensure you complete the following for every upgrade:

  • Update all libraries to the latest SDK version; for example, 7.2.0.
  • Run the command pod repo update to ensure all references are up to date (for example, Geo SDK).

Version 7.2.0

There are no code changes required to upgrade to Swrve iOS SDK v7.2.0.

Version 7.1.0

There are no code changes required to upgrade to Swrve iOS SDK v7.1.0.

Version 7.0.3

There are no code changes required to upgrade to Swrve iOS SDK v7.0.3.

Version 7.0.2

There are no code changes required to upgrade to Swrve iOS SDK v7.0.2.

Version 7.0.1

There are no code changes required to upgrade to Swrve iOS SDK v7.0.1.

Version 7.0.0

This section provides information for upgrading to Swrve iOS SDK v7.0.0.

We’ve made several changes to the SDK to simplify integration for future releases.

  • The SwrveMessageController class is now internal and no longer accessible via the ‘messaging’ property.
  • Moved certain methods and functionalities to the SwrveSDK and SwrveInAppMessageConfig classes.
  • Updated the spelling and syntax of certain methods and configuration.

The following table lists the methods and fields that have changed or been moved.

Removed Summary
showMessageTransition:
installButtonCallback:
messageForEvent:		 Methods no longer needed or supported.
SWRVE_LOG_IDFA Use new public API [SwrveSDK idfa:] to set the IDFA after the user has given their permission.
SWRVE_LOG_IDFV Use new config value config.autoCollectIDFV = true to auto-collect the IDFV.
Moved or changed Summary
messageCenterCampaignsWithPersonalization: Moved from the SwrveMessageController class to SwrveSDK and updated spelling (-is to -iz).
messageCenterCampaigns:
showMessageCenterCampaign:
embeddedMessageWasShownToUser:
embeddedButtonWasPressed:
removeMessageCenterCampaign:
markMessageCenterCampaignAsSeen:		 Moved from the SwrveMessageController class to SwrveSDK.
showMessageDelegate:
customButtonCallback:
dismissButtonCallback:
clipboardButtonCallback:		 Moved to SwrveInAppMessageConfig.
personalizationCallback: Moved to SwrveInAppMessageConfig and updated spelling (-is to -iz).
prefersIAMStatusBarHidden:
(now prefersStatusBarHidden:)
inAppMessageBackgroundColor:
(now backgroundColor:)		 Moved configuration from SwrveConfig to SwrveInAppMessageConfig and changed property name to provide more context.
personalizationForegroundColor:
personalizationBackgroundColor:
personalizationFont:		 Updated spelling (-is to -iz).
managedModeAutoStartLastUser Renamed to autoStartLastUser

Version 6.8.1

There are no code changes required to upgrade to Swrve iOS SDK v6.8.1.

Version 6.8.0

This section provides information for upgrading to Swrve iOS SDK v6.8.0.

Embedded campaigns

For information on adding embedded campaigns to your Swrve integration, see the iOS integration guide.

Version 6.7.1

There are no code changes required to upgrade to Swrve iOS SDK v6.7.1.

Version 6.7.0

There are no code changes required to upgrade to Swrve iOS SDK v6.7.0.

Version 6.6.2

There are no code changes required to upgrade to Swrve iOS SDK v6.6.2.

Version 6.6.1

There are no code changes required to upgrade to Swrve iOS SDK v6.6.1.

Version 6.6.0

There are no code changes required to upgrade to Swrve iOS SDK v6.6.0.

Version 6.5.4

There are no code changes required to upgrade to Swrve iOS SDK v6.5.4.

Version 6.5.3

There are no code changes required to upgrade to Swrve iOS SDK v6.5.3.

Version 6.5.2

There are no code changes required to upgrade to Swrve iOS SDK v6.5.2.

Version 6.5.1

There are no code changes required to upgrade to Swrve iOS SDK v6.5.1.

Version 6.5.0

There are no code changes required to upgrade to Swrve iOS SDK v6.5.0.

Version 6.4.2

There are no code changes required to upgrade to Swrve iOS SDK v6.4.2.

Version 6.4.1

There are no code changes required to upgrade to Swrve iOS SDK v6.4.1.

Version 6.4.0

This section provides information for upgrading to Swrve iOS SDK v6.4.0.

Push delivery tracking

Swrve now automatically tracks and logs when push notifications are delivered and displayed on each device. To manage this, the iOS SDK uses a notification service app extension and app group. For information on how to implement these in your app, see the iOS integration guide.

Version 6.3.1

There are no code changes required to upgrade to Swrve iOS SDK v6.3.1.

Version 6.3.0

This section provides information for upgrading to Swrve iOS SDK v6.3.0.

Delayed initialization and custom user ID

For information about how to configure the SDK to delay initialization and set a custom user ID for tracking purposes, see the iOS integration guide.

Version 6.0.1-6.2.0+

There are no code changes required to upgrade to Swrve iOS SDK v6.0.1-6.2.0+.

Version 6.0.0

This section provides information for upgrading to Swrve iOS SDK v6.0.0.

Removed Summary
+(void) processNotificationResponseWithIdentifier:(NSString *)identifier andUserInfo:(NSDictionary *)userInfo; No longer applicable with minimum support set at iOS 10.
+(void)pushNotificationReceived:(NSDictionary*)userInfo; No longer applicable with minimum support set at iOS 10.
+(void) sharedInstanceWithAppID:(int)swrveAppID apiKey:(NSString*)swrveAPIKey launchOptions:(NSDictionary*)launchOptions; Removed launch options from the initilization, no longer required.
+(void) sharedInstanceWithAppID:(int)swrveAppID apiKey:(NSString*)swrveAPIKey config:(SwrveConfig*)swrveConfig launchOptions:(NSDictionary*)launchOptions; Removed launch options from the initilization, no longer required.
userId property from SwrveConfig To set a custom user ID, use our new Identify API call. For more information, see the iOS integration guide.
SWRVE_ADDRESS_BOOK
SWRVE_LOCATION
SWRVE_PHOTO_LIBRARY
SWRVE_PHOTO_CAMERA		 Removed the iOS permissions-related optional framework build flags. Enable permissions by implementing the SwrvePermissionsDelegate delegate. For more information, see the iOS integration guide.
pushCategories property from SwrveConfig.h Removed support for non-iOS 10+ push categories. Use the notificationCategories property instead.
Removed configuration of HTTP from SwrveConfig The SDK now only supports HTTPS.

Authenticated push

If you want to use our new user identity authenticated push feature, ensure you configure your app to use silent notifications. For information on how to configure silent notifications, see the iOS integration guide.

Previous versions

If you are upgrading from a version older than 6.0.0, please refer to the iOS Integration Guide.