iOS modal rich media

Starting from Pushwoosh SDK version 6.7.5, you have the ability to send Modal Rich Media.

We are introducing new Modal Rich Media, which can be customized. The new Modal Rich Media do not completely block the screen and can be positioned in different parts of the screen (top, bottom, and center).

For more information on Rich Media pages, please refer to our guide.

Configuration

//for silent push notifications
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    Pushwoosh.sharedInstance().handlePushReceived(userInfo)
    completionHandler(.noData)
}

To enable the display of Modal Rich Media, set the parameter Pushwoosh_RICH_MEDIA_STYLE in your info.plist and assign it the value MODAL_RICH_MEDIA.

Info.plist:

<key>Pushwoosh_RICH_MEDIA_STYLE</key>
<string>MODAL_RICH_MEDIA</string>

By default, Modal Rich Media will be displayed in the center of the screen with a bottom-to-top appearance animation.

To configure the display of Modal Rich Media (screen position, show animation, close animation), you need to use the following method:

// Modal Rich Media Configuration
PWModalWindowConfiguration.shared().configureModalWindow(with: .PWModalWindowPositionCenter,
                                                                 present: .PWAnimationPresentFromBottom,
                                                                 dismiss: .PWAnimationDismissUp)

Modal Rich Media can be positioned in three locations: top, bottom, or center.

/**
 Enum defining the possible positions for displaying a modal window.

 - `PWModalWindowPositionTop`: The modal window appears at the top of the screen, within the safe area.
 - `PWModalWindowPositionCenter`: The modal window appears at the center of the screen, within the safe area.
 - `PWModalWindowPositionBottom`: The modal window appears at the bottom of the screen, within the safe area.
 - `PWModalWindowPositionBottomSheet`: The modal window appears at the very bottom of the screen, ignoring the safe area.
 - `PWModalWindowPositionDefault`: The default position is the center of the screen, within the safe area.
 */
typedef NS_ENUM(NSInteger, ModalWindowPosition) {
    PWModalWindowPositionTop,       // Appears at the top of the screen (within safe area)
    PWModalWindowPositionCenter,    // Appears at the center of the screen (within safe area)
    PWModalWindowPositionBottom,    // Appears at the bottom of the screen (within safe area)
    PWModalWindowPositionBottomSheet, // Appears at the very bottom of the screen (ignores safe area)
    PWModalWindowPositionFullScreen, // Fullscreen, ignores safe area insets
    PWModalWindowPositionDefault    // Default position (center of the screen, within safe area)
};

The example below shows a Modal Rich Media displayed at the top of the screen.

Modal Rich Media show animations include:

typedef NS_ENUM(NSInteger, PresentModalWindowAnimation) {
    PWAnimationPresentFromBottom,
    PWAnimationPresentFromTop,
    PWAnimationPresentFromRight,
    PWAnimationPresentFromLeft,
    PWAnimationPresentNone
};

Modal Rich Media close animations include:

typedef NS_ENUM(NSInteger, DismissModalWindowAnimation) {
    PWAnimationDismissDown,
    PWAnimationDismissUp,
    PWAnimationDismissLeft,
    PWAnimationDismissRight,
    PWAnimationCurveEaseInOut,
    PWAnimationDismissNone,

    /**
     * Default dismiss animation is `PWAnimationCurveEaseInOut`
     */
    PWAnimationDismissDefault
};

The example below demonstrates displaying Modal Rich Media at the bottom of the screen with a left-to-right show animation and a rightward close animation:

Additional parameters for displaying Modal Rich Media include options like adding options like adding haptic feedback of type vibration, enabling swipe gestures, and setting an automatic close timer after a specified duration.

// Haptic Feedback Type
PWModalWindowConfiguration.shared().setPresent(.PWHapticFeedbackLight)

/**
enum HapticFeedbackType

typedef NS_ENUM(NSInteger, HapticFeedbackType) {
    PWHapticFeedbackLight,         // Light vibration feedback
    PWHapticFeedbackMedium,        // Medium vibration feedback
    PWHapticFeedbackHard,          // Strong vibration feedback

    /**
     * Vibration is off by default.
     */
    PWHapticFeedbackNone
};
*/

// Swipe directions
let directions: [NSNumber] = [
    NSNumber(value: DismissSwipeDirection.PWSwipeDismissDown.rawValue),
    NSNumber(value: DismissSwipeDirection.PWSwipeDismissUp.rawValue)
]
PWModalWindowConfiguration.shared().setDismissSwipeDirections(directions)

/**
typedef NS_ENUM(NSInteger, DismissSwipeDirection) {
    PWSwipeDismissDown,
    PWSwipeDismissUp,
    PWSwipeDismissLeft,
    PWSwipeDismissRight,
    PWSwipeDismissNone
};
*/

// Set Rich Media corner radius
PWModalWindowConfiguration.shared().setCornerType([.PWCornerTypeTopLeft, .PWCornerTypeBottomRight], withRadius: 30.0)

// Close Modal Rich Media after N seconds
PWModalWindowConfiguration.shared().closeModalWindow(after: 3)

PWRichMediaPresentingDelegate

To manage the queue of modal rich media, you need to implement the delegate methods of PWRichMediaPresentingDelegate. When using this functionality, modal rich media are presented sequentially, and the next one will not be displayed until the user closes the current one. Once the user closes the presented rich media, the next one, which was part of a different push notification, will be shown.

To implement this functionality, use the code provided below:

import UIKit
import PushwooshFramework

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()

        PWRichMediaManager.shared().delegate = ChainedRichMediaPresentingDelegate.init(queue: [], inApp: false)
    }
}

class ChainedRichMediaPresentingDelegate: NSObject, PWRichMediaPresentingDelegate {

    var queue: [PWRichMedia]
    var inAppIsPresenting: Bool

    init(queue: [PWRichMedia], inApp: Bool) {
        self.queue = queue
        self.inAppIsPresenting = inApp
        super.init() // can actually be omitted in this example because will happen automatically.
    }

    convenience override init() {
        self.init(queue: [], inApp: false)
    }

    func richMediaManager(_ richMediaManager: PWRichMediaManager!, shouldPresent richMedia: PWRichMedia!) -> Bool {
        if !queue.contains(where: { $0 === richMedia }) {
            queue.append(richMedia)
        }
        return !inAppIsPresenting
    }

    func richMediaManager(_ richMediaManager: PWRichMediaManager!, didPresent richMedia: PWRichMedia!) {
        inAppIsPresenting = true
    }

    func richMediaManager(_ richMediaManager: PWRichMediaManager!, didClose richMedia: PWRichMedia!) {
        inAppIsPresenting = false

        if let idx = queue.firstIndex(where: { $0 === richMedia }) {
            queue.remove(at: idx)
        }

        if ((queue.count) != 0) {
            PWModalWindowConfiguration.shared().presentModalWindow(queue.first!)
        }
    }

    func richMediaManager(_ richMediaManager: PWRichMediaManager!, presentingDidFailFor richMedia: PWRichMedia!, withError error: Error!) {
        self.richMediaManager(richMediaManager, didClose: richMedia)
    }
}

iOS modal rich media

Configuration

Modal Rich Media positioning

Additional parameters for Modal Rich Media

PWRichMediaPresentingDelegate