Migrate to Version 6.4
Please follow the below guide to migrate from the HyprMX SDK 6.x to 6.4.
HyprMX SDK 6.4 contains a revamp to our public API, streamlining our SDK's initialization and providing more focused callbacks and delegates. Additionally, we now provide modernized asynchronous APIs that you can opt into, and have removed the main thread requirement from all of our public methods.
SDK Migration
The HyprMX iOS SDK 6.x can be migrated to 6.4 through CocoaPods or by Manual Migration.
CocoaPods
To migrate the HyprMX SDK with CocoaPods, update the pod to 6.4.0
in your Podfile:
Run pod install
from the terminal in the directory containing your Podfile.
Manual Migration
To manually migrate the framework, follow the steps below.
1. Download the SDK here and unzip the file.
2. Right-click on HyprMX.xcframework in your project navigator and select Show in Finder.
3. Drag and drop the new 6.4 HyprMX.xcframework (available in the zip) into the folder that contains the 6.3 HyprMX.xcframework and Replace the old one.
Fixing Your Broken Build
See below for migrations related to HyprMX SDK 6.4.
Migrating HyprMX.initialize
The new SDK initializer now only requires a distributorId
, and takes a completion closure or returns a Result depending on the API chosen:
Other parameters that used to be provided to the initialization API now have new setters. These parameters can now be set after initialization when the information is available. As a result, you will need to migrate the following parameters:
consentStatus
ageRestrictedUser
userID
Follow the steps below to migrate the parameters.
Migrating the consentStatus
parameter
consentStatus
parameterMigrating the ageRestrictedUser
parameter
ageRestrictedUser
parameterMigrating the userID
parameter
userID
parameterOur API no longer accepts user ID.
HyprMXInitializationDelegate
HyprMXInitializationDelegate has been replaced with async Result
or completion closure. To migrate existing code:
Remove any references to
HyprMXInitializationDelegate
from your project.When
success
is true, call your existinginitializationDidComplete
method or logic.When
success
is false, call your existinginitializationFailed
method or logic.
Completion blocks are invoked from the same operation queue the SDK is called from, a slight behavioral difference between the async and completion variants.
Migrating HyprMXPlacement.isAdAvailable
If used in any Swift source files, remove trailing parenthesis from placementInstance.isAdAvailable
Migrating HyprMXPlacement.loadAd
loadAd
doesn't use a delegate in HyprMX SDK 6.4. Instead, it returns results via async result or completion based callbacks. To migrate existing code:
When
success
is true, invoke your formeronAdAvailable
implementation.When
success
is false, invoke your formeronAdNotAvailable
implementation.
Completion blocks are invoked from the same operation queue the SDK is called from, a slight behavioral difference between the async and completion variants.
Migrating HyprMXPlacementDelegate
HyprMXPlacementDelegate has been renamed to HyprMXPlacementShowDelegate. The SDK takes the delegate as a parameter in showAd, and stops using that delegate instance after calling adDidClose. To migrate existing code:
1. Rename references to HyprMXPlacementDelegate
to HyprMXPlacementShowDelegate
2. Pass the show delegate as the second parameter to showAd
3. If you need callbacks to adExpired
then implement the HyprMXPlacementExpiredDelegate
And set the expired delegate on your placement:
4. If your project implemented HyprMXPlacementDelegate
in Swift, then it needs a few adjustments:
Remove
for
fromadWillstart
:
Remove
for
anddidFinishAd
fromadDidClose
and replaceAny!
withBool
Remove
adDisplayError(for placement: HyprMXPlacement, error hyprMXError: HyprMXError)
Remove
Error
and the underscore fromadDisplayError(_ error: Any!, placement: HyprMXPlacement)
Remove
for
fromadDidReward
and replace the twoAny!
types withString?
andInt
Remove
for
fromadExpired
HyprMX SDK always holds weak references to delegates.
HyprMXBannerView.loadAd
loadAd
doesn't use a delegate in HyprMX SDK 6.4. Instead, it returns results via async or completion based paths. To migrate existing code:
When
success
is true, invoke youradDidLoad
implementationWhen
success
is false, invoke youradFailedToLoad:error:
implementation
Migration complete.
Last updated