Customize click behaviors (iOS)

The SDK provides behavior delegate methods to customize click behaviors, including those for the video CTA button, product cards, and shopping CTA button.

Customize video overlay CTA button click behavior

1. Set FireworkVideoCTADelegate delegate:

FireworkVideoSDK.ctaDelegate = <FireworkVideoCTADelegate delegate>

2. Implement handleCustomCTAClick(_:url:for:):

func handleCustomCTAClick(
    _ viewController: PlayerViewController,
    url: URL,
    for video: VideoDetails
) -> Bool {
    // Here, you could write codes to navigate to the host app page.
    // For best practices on navigating to the host page,
    // please consult "Navigate to the host app page" below.

    // Return true to customize video overlay CTA button click behavior
    return true
}

You could write codes to navigate to the host app page within the delegate method. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize click behaviors for shopping

To customize click behaviors for shopping, you need to set FireworkVideoShoppingDelegate delegate first:

FireworkVideoSDK.shopping.delegate = <FireworkVideoShoppingDelegate delegate>

Customize product card click behavior

Implement fireworkShopping(_:didTapProductVariant:forVideo:):

func fireworkShopping(
    _ fireworkShopping: FireworkVideoShopping,
    didTapProductVariant item: SelectedProductVariant,
    forVideo video: VideoDetails
) -> Bool {
    // Here, you could write codes to navigate to the host app page.
    // For best practices on navigating to the host page,
    // please consult "Navigate to the host app page" below.

    // Return true to customize product card click behavior
    return true
}

You could write codes to navigate to the host app page within the delegate method. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize shopping CTA click behavior

Implement fireworkShopping(_:productVariantCTASelected:fromVideo:ctaCompletionHandler:):

func fireworkShopping(
    _ fireworkShopping: FireworkVideoShopping,
    productVariantCTASelected item: SelectedProductVariant,
    fromVideo video: VideoDetails,
    ctaCompletionHandler: @escaping ShoppingCTAHandler
) {
    // Here, you could write codes to navigate to the host app page.
    // For best practices on navigating to the host page,
    // please consult "Navigate to the host app page" below.

    // Calling completion closure with none refer to
    // host app will customize the click behavior
    ctaCompletionHandler(.none)
}

You could write codes to navigate to the host app page within the delegate method. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize product link button click behavior

Implement fireworkShopping(_:didTapLinkButtonAt:fromVideo:withURL:):

func fireworkShopping(
        _ fireworkShopping: FireworkVideoShopping,
        didTapLinkButtonAt item: SelectedProductVariant,
        fromVideo video: VideoDetails,
        withURL itemURL: String
    ) -> Bool {
        // Here, you could write codes to navigate to the host app page.
        // For best practices on navigating to the host page,
        // please consult "Navigate to the host app page" below.

        // Return true to customize product link button click behavior
        return true
}

You could write codes to navigate to the host app page within the delegate method. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize cart icon click behavior

1. Set cartAction to custom:

FireworkVideoSDK.shopping.cartAction = .custom

1. Implement fireworkShopping(_:didTapCartIconForVideo:):

func fireworkShopping(
    _ fireworkShopping: FireworkVideoShopping,
    didTapCartIconForVideo videoDetails: VideoDetails
) {
    // Here, you could write codes to navigate to the host app page.
    // For best practices on navigating to the host page,
    // please consult "Navigate to the host app page" below.
}

You could write codes to navigate to the host app page within the delegate method. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Custom livestream link interaction click behavior

1. Set FireworkLiveStreamBehaviorDelegate delegate:

FireworkVideoSDK.liveStreamBehaviorDelegate = <FireworkLiveStreamBehaviorDelegate delegate>

1. Implement fireworkLiveStream(_:didTapLinkInteraction:):

func fireworkLiveStream(
    _ liveStream: LiveStreamEventDetails,
    didTapLinkInteraction interaction: LiveStreamLinkInteraction
) -> Bool {
    // Here, you could write codes to navigate to the host app page.
    // For best practices on navigating to the host page,
    // please consult "Navigate to the host app page" below.

    // Return true to customize livestream link interaction click behavior
    return true
}

You could write codes to navigate to the host app page within the delegate method. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize social attribution click behavior

1. Set FireworkVideoSocialDelegate delegate:

FireworkVideoSDK.socialDelegate = <FireworkVideoSocialDelegate delegate>

1. Implement handleSocialAttributionClick(_:fromVideo:):

func handleSocialAttributionClick(
    _ source: VideoSocialAttributionSource,
    fromVideo video: VideoDetails,
) -> Bool {
    // This delegate method allows the host app to customize the behavior when users tap on
    // social media attribution displayed in videos. If the host app returns `false` or if
    // this delegate is not set, the SDK will open the URL using `UIApplication.shared.open`.
    return false
}

Navigate to the host app page

We have three ways to navigate to the host app page when customizing click behaviors.

1. Present the host app page over the SDK player.

2. Use the host app navigation controller to push the host app page.

Present the host app page

As the following code snippets, we use "present" to navigate to the host app PDP page. The code snippets are:

func fireworkShopping(
    _ fireworkShopping: FireworkVideoShopping,
    didTapProductVariant item: SelectedProductVariant,
    forVideo video: VideoDetails
) -> Bool {
    // The following PDP view controller is a sample.
    // Please create your own PDP view controller.
    let pdpVC = UIViewController()
    // As we may have other flows in PDP(such as the checkout page),
    // we could embed the PDP controller with navigation controller.
    let nav = UINavigationController(rootViewController: pdpVC)
    nav.modalPresentationStyle = .fullScreen
    UIViewController.topPresentedVC()?.present(nav, animated: true)
    
    // Return true to customize product card click behavior
    return true
}

Use the host app navigation controller to push the host app page

When the SDK fullscreen player is displayed, the host app's navigation controller is positioned beneath it. When the host app navigates to a new page using its navigation controller while customizing click behaviors, it will be obscured by the Firework full-screen player.

When a Firework full-screen player is present, FireworkVideoSDK.startPiPOrDismissFullScreenPlayer will either transition it to a floating player (if PiP is enabled), or dismiss it (if PiP is disabled). This approach ensures that the new host app page will not be obscured by the Firework full-screen player. If you wish to consistently dismiss the full-screen player, regardless of whether PiP is enabled or not, you can use the FireworkVideoSDK.dismissFullScreenPlayer API.

func fireworkShopping(
    _ fireworkShopping: FireworkVideoShopping,
    didTapProductVariant item: SelectedProductVariant,
    forVideo video: VideoDetails
) -> Bool {
    /*
     When a Firework full-screen player is present, startPiPOrDismissFullScreenPlayer will either
     transition it to a floating player (if PiP is enabled), or dismiss it (if PiP is disabled).
     If you wish to consistently dismiss the full-screen player, regardless of whether PiP is
     enabled or not, you can use the dismissFullScreenPlayer API.
     */
    FireworkVideoSDK.startPiPOrDismissFullScreenPlayer { _ in
        // Use host app navigation controller to push the host app page.
        // But you can also use your own method to push the host app page.
        if let nav = FireworkVideoSDK.getHostAppNavigationController() {
            // The following PDP view controller is a sample.
            // Please create your own PDP view controller.
            let pdpVC = UIViewController()
            nav.pushViewController(pdpVC, animated: true)
        }
    }
    return true
}

The above code snippets are based on fireworkShopping(_:didTapProductVariant:forVideo:). But they are also applicable to other behavior delegate methods.