​

Overview

​

Implementing a Transactional Live Activity

​

Step 1: Add a Widget Extension

1. In Xcode, navigate to File > New > Target.
2. Select Widget Extension and click Next.
   
3. Enter a product name for your widget.
4. Select the Include Live Activities checkbox.
   
5. Click Finish.

​

Step 2: Configure App’s Info.plist

<key>NSSupportsLiveActivities</key>
<true/>

​

Step 3: MoEngageLiveActivity integration

​

Install using Swift Package Manager (Recommended )

​

Install using CocoaPod

target 'MoETest' do
  use_frameworks!

  # Pods for app target
  pod 'MoEngage-iOS-SDK' # specify version constraint
  pod 'MoEngage-iOS-SDK/LiveActivity'

  target 'LiveActivity' do
    use_frameworks!
    inherit! :search_paths
    # Pods for live activity extension target
    pod 'MoEngage-iOS-SDK/LiveActivity'
  end
end

​

Step 4: Define the Live Activity Attributes

1. Configure ActivityAttributes: Create a struct that conforms to ActivityAttributes. This struct will contain:
   • Static Data: Attributes that are set once and do not change (e.g., Order Number).
   • ContentState: A nested struct for dynamic data that will be updated in real-time (e.g., Delivery Status).
     Swift

     import Foundation
     import ActivityKit
     import WidgetKit
     import SwiftUI
     
     struct FoodOrderAttributes: ActivityAttributes {
         public struct ContentState: Codable, Hashable {
             // Dynamic stateful properties about your order go here!
             var status: String // e.g., "Out for Delivery"
             var estimatedMinutes: Int
         }
     
         // Fixed non-changing properties about your order go here!
         var orderNumber: String
         var restaurantName: String
     }
     
2. When creating ActivityConfiguration, use MoEngageTransactionActivityAttributes<FoodOrderAttributes> instead of FoodOrderAttributes as your ActivityAttributes type for transactional support.
3. Track widget clicks by configuring the deeplink and widget ID with the moengageWidgetClickURL API.
   Swift

   import ActivityKit
   import WidgetKit
   import SwiftUI
   import MoEngageLiveActivity
   
   struct FoodOrderWidget: Widget {
       var body: some WidgetConfiguration {
           ActivityConfiguration(for: MoEngageTransactionActivityAttributes<FoodOrderAttributes>.self) { context in
               // Lock screen/banner UI goes here
               VStack(spacing: 12) {
                   Text(context.attributes.appAttributes.restaurantName)
                   Text(context.state.appContent.status)
               }
               .moengageWidgetClickURL(URL(string: "moeapp://order-tracking"), context: context, widgetId: 2)
               
           } dynamicIsland: { context in
               DynamicIsland {
                   // Expanded UI goes here
               } compactLeading: {
                   Text("Preparing")
               } compactTrailing: {
                   Text("\(context.state.appContent.estimatedMinutes)m")
               } minimal: {
                   Text("Preparing")
               }
               .moengageWidgetClickURL(URL(string: "moeapp://order-tracking"), context: context, widgetId: 1)
           }
       }
   }
   
4. Ensure Target Membership: Make your ActivityAttributes struct accessible to your main app target.
   1. Select the Swift file where you defined your ActivityAttributes.
   2. Open the File Inspector (Option + Command + 1).
   3. In the Target Membership section, check the box for your main app target.

​

Step 5: Monitor Live Activities

Task {
         if #available(iOS 18, *) {
             await MoEngageSDKLiveActivity.monitorLiveActivities(types: [ FoodOrderAttributes.self]) { data in
                     print("Push token generated for live activity",data)
             }
          }
      }

   public struct MoEngageTransactionCampaignData {
        public struct MoEngageTokenData {
              public let transactionId: String
              public let shortToken: String
        }
        
        public let accountMeta: MoEngageAccountMeta
        public let tokenData: MoEngageTokenData
    }

    public class MoEngageAccountMeta {
        /// Account identifier, APP ID on the MoEngage Dashboard.
        public let appID: String
    }

​

Managing the Live Activity Lifecycle

​

Step 6: Start a Transactional Live Activity

​

Push-to-Start (Remote)

​

Click-to-Start (Local)

MoEngageSDKLiveActivity.createAttributes(
    withCampaign: .init(
        campaignId: campaignId,
        campaignName: "Order Tracking \(orderId)",
        transactionId: transactionId,
        attributeType: "\(FoodOrderAttributes.self)",
        instanceId: instanceId,
        appAttributes: FoodOrderAttributes(orderNumber: "ORD-123", restaurantName: "Pizza Palace"),
        appContent: FoodOrderAttributes.ContentState(status: "Preparing", estimatedMinutes: 30)
    )
) { [weak self] result in
    guard let result = result else {
        self?.view.makeToast("No Live Activity creation result")
        return
    }
    
    do {
        let activity = try MoEngageTransactionActivity<FoodOrderAttributes>.request(
            attributes: result.attributes,
            content: .init(
                state: result.content,
                staleDate: .distantFuture,
                relevanceScore: 10
            ),
            pushType: .token,
            style: .standard
        )
        MoEngageSDKLiveActivity.trackStarted(activity: activity)
        self?.view.makeToast("Order Tracking Live Activity started successfully")
    } catch {
        self?.view.makeToast("Activity request error: \"\(error.localizedDescription)\"")
    }
}

​

Step 7: Update a Live Activity

​

Step 8: End a Live Activity