Skip to content
User guidesSupport Request demo Sign in
Pushwoosh.com

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

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

Option 1: Info.plist configuration

Anchor link to

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>

Option 2: Programmatic configuration (SDK 7.0.14+)

Anchor link to

You can also configure the Rich Media presentation style programmatically in your AppDelegate:

func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {


    // Set modal presentation style
    Pushwoosh.media.setRichMediaPresentationStyle(.modal)


    // Configure modal window appearance
    Pushwoosh.media.modalRichMedia.configure(
        position: .PWModalWindowPositionBottom,
        presentAnimation: .PWAnimationPresentFromBottom,
        dismissAnimation: .PWAnimationDismissDown
    )


    Pushwoosh.configure.registerForPushNotifications()
    return true
}

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

Anchor link to

Modal Rich Media can be positioned in different locations on the screen.

/**
 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 Modal Rich Media

Anchor link to

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

// Haptic Feedback Type
Pushwoosh.media.modalRichMedia.setHapticFeedbackType(.PWHapticFeedbackLight)


// Swipe directions to dismiss
Pushwoosh.media.modalRichMedia.setDismissSwipeDirections([
    NSNumber(value: DismissSwipeDirection.PWSwipeDismissDown.rawValue),
    NSNumber(value: DismissSwipeDirection.PWSwipeDismissUp.rawValue)
])


// Set Rich Media corner radius
let topCorners = PWCornerTypeTopLeft.rawValue | PWCornerTypeTopRight.rawValue
Pushwoosh.media.modalRichMedia.setCornerType(CornerType(rawValue: topCorners), withRadius: 16)


// Close Modal Rich Media after N seconds
Pushwoosh.media.modalRichMedia.closeAfter(3)

Haptic Feedback Types:

typedef NS_ENUM(NSInteger, HapticFeedbackType) {
    PWHapticFeedbackLight,         // Light vibration feedback
    PWHapticFeedbackMedium,        // Medium vibration feedback
    PWHapticFeedbackHard,          // Strong vibration feedback
    PWHapticFeedbackNone           // Vibration is off (default)
};

Swipe Directions:

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

PWRichMediaPresentingDelegate

Anchor link to

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.

import UIKit
import PushwooshFramework


@main
class AppDelegate: UIResponder, UIApplicationDelegate, PWRichMediaPresentingDelegate {


    var richMediaQueue: [PWRichMedia] = []
    var isPresenting = false


    func application(_ application: UIApplication,
                     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {


        // Configure modal rich media
        Pushwoosh.media.setRichMediaPresentationStyle(.modal)
        Pushwoosh.media.modalRichMedia.configure(
            position: .PWModalWindowPositionBottom,
            presentAnimation: .PWAnimationPresentFromBottom,
            dismissAnimation: .PWAnimationDismissDown
        )


        // Set delegate
        Pushwoosh.media.modalRichMedia.delegate = self


        Pushwoosh.configure.registerForPushNotifications()
        return true
    }


    // MARK: - PWRichMediaPresentingDelegate


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


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


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


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


        // Present next rich media in queue
        if let nextRichMedia = richMediaQueue.first {
            Pushwoosh.media.modalRichMedia.present(nextRichMedia)
        }
    }


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