​

概要

​

トランザクショナル Live Activity の実装

​

ステップ 1: Widget Extension を追加する

1. Xcode で File > New > Target に移動します。
2. Widget Extension を選択し、Next をクリックします。
   
3. ウィジェットのプロダクト名を入力します。
4. Include Live Activities チェックボックスを選択します。
   
5. Finish をクリックします。

​

ステップ 2: アプリの Info.plist を構成する

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

​

ステップ 3: MoEngageLiveActivity の統合

​

Swift Package Manager を使用したインストール(推奨)

​

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

​

ステップ 4: Live Activity の属性を定義する

1. ActivityAttributes を構成する: ActivityAttributes に準拠する struct を作成します。この struct には以下が含まれます。
   • 静的データ: 一度設定されると変更されない属性(例: 注文番号)。
   • ContentState: リアルタイムで更新される動的データ用のネストされた struct(例: 配達状況)。
     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. ActivityConfiguration を作成する際は、トランザクションをサポートするために、ActivityAttributes の型として FoodOrderAttributes の代わりに MoEngageTransactionActivityAttributes<FoodOrderAttributes> を使用します。
3. moengageWidgetClickURL API でディープリンクとウィジェット ID を構成して、ウィジェットのクリックをトラッキングします。
   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. Target Membership を確認する: ActivityAttributes struct がメインアプリのターゲットからアクセスできるようにします。
   1. ActivityAttributes を定義した Swift ファイルを選択します。
   2. File Inspector を開きます(Option + Command + 1)。
   3. Target Membership セクションで、メインアプリのターゲットのチェックボックスをオンにします。

​

ステップ 5: 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
    }

​

Live Activity のライフサイクル管理

​

ステップ 6: トランザクショナル Live Activity を開始する

​

Push-to-Start(リモート)

​

Click-to-Start(ローカル)

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)\"")
    }
}

​

ステップ 7: Live Activity を更新する

​

ステップ 8: Live Activity を終了する