​

概要

​

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に準拠する構造体を作成します。この構造体には次のものが含まれます。
   • 静的データ: 一度設定されると変更されない属性。
   • ContentState: リアルタイムで更新される動的データ用のネストされた構造体。
     Swift

     import Foundation
     import ActivityKit
     import WidgetKit
     import SwiftUI
     struct FootballActivityAttributes: ActivityAttributes {
         public struct ContentState: Codable, Hashable {
             // Dynamic stateful properties about your activity go here!
             var teamOneScore: Int
             var teamTwoScore: Int
         }
         // Fixed non-changing properties about your activity go here!
         var team1Name: String
         var team2Name: String
     }
     
2. ActivityConfigurationを作成する際は、ActivityAttributesの型としてFootballActivityAttributesの代わりに MoEngageActivityAttributes<FootballActivityAttributes> を使用します。
3. moengageWidgetClickURL APIでディープリンクとウィジェットIDを設定して、ウィジェットのクリックをトラッキングします。
   Swift

   import ActivityKit
   import WidgetKit
   import SwiftUI
   import MoEngageLiveActivity
   struct FootballActivityWidget: Widget {
       var body: some WidgetConfiguration {
           ActivityConfiguration(for: MoEngageActivityAttributes<FootballActivityAttributes>.self) { context in
               // Lock screen/banner UI goes here
               VStack(spacing: 12) {
                   // UI elements
               }
               .moengageWidgetClickURL(URL(string: "moeapp://game"), context: context, widgetId: 2)
               
           } dynamicIsland: { context in
               DynamicIsland {
                   // Expanded UI goes here
               } compactLeading: {
                   // Compact Leading UI goes here
               } compactTrailing: {
                   // Compact Trailing UI goes here
               } minimal: {
                   // Minimal UI goes here
               }
               .moengageWidgetClickURL(URL(string: "moeapp://game"), context: context, widgetId: 1)
           }
       }
   }
   
   情報 AppleのLive Activitiesの前提条件と制限事項はMoEngageのものとは異なるため、事前によく理解しておくことをMoEngageは推奨しています。
4. Target Membershipを確認する: ActivityAttributes構造体がメインアプリのターゲットからアクセスできるようにします。
   1. ActivityAttributesを定義したSwiftファイルを選択します。
   2. File Inspector を開きます(Option + Command + 1)。
   3. Target Membership セクションで、メインアプリのターゲットのチェックボックスをオンにします。
      

​

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

​

ステップ5: Live Activityキャンペーンの作成(1回限りのセットアップ)

• ターゲットセグメントに対してリモートで開始するキャンペーンを識別します。
• 元のターゲットセグメント外のユーザーが、アプリ内から(ボタンをタップするなどして)同じLive Activityをローカルで開始できるようにします。

​

ステップ6: Live Activityの開始

​

Push-to-Start(リモート)

​

Click-to-Start(ローカル)

import MoEngageLiveActivity

guard #available(iOS 18, *) else { return }

guard let result = await MoEngageSDKLiveActivity.createAttributes(
    withCampaign: MoEngageSDKLiveActivity.Campaign(
        campaignId: "Your Campaign Id", campaignName: "Your Campaign Name",
        deliveryType: "Broadcast Live Activity",
        attributeType: "\(FootballActivityAttributes.self)",
        instanceId: "Your Instance Id",
        appAttributes: FootballActivityAttributes(team1Name: "Chiefs", team2Name: "Bills"),
        appContent: FootballActivityAttributes.ContentState(teamOneScore: 0, teamTwoScore: 0)
    )
) else { return }

do {
    let activity = try MoEngageActivity.request(
        attributes: result.attributes,
        content: .init(
            state: result.content, staleDate: .distantFuture,
            relevanceScore: 10
        ),
        pushType: .channel("Your channel Id"), style: .standard
    )
    // Track started event
    MoEngageSDKLiveActivity.trackStarted(activity: activity)
} catch {
    // log error
}

​

ステップ7: Live Activityの更新

​

ステップ8: Live Activityの終了