iOS Live Activities

Live Activities отображают самые актуальные данные вашего приложения на экране блокировки iPhone или iPad и в Dynamic Island. Эта функция позволяет пользователям мгновенно просматривать актуальную информацию и выполнять быстрые действия, связанные с отображаемой информацией.

Вот несколько примеров использования Live Activities:

Отображение статуса заказа в приложении доставки;
Отображение обратного отсчета в реальном времени в приложении для тренировок;
Отображение информации об отслеживании в приложении такси;
Отображение игровой статистики и текущего счета в спортивном приложении;
Предоставление ежечасных прогнозов в погодном приложении.

Вы можете включить Live Activities с помощью Pushwoosh iOS SDK, как описано ниже. Для управления Live Activities и обновления их содержимого используйте метод /updateLiveActivity.

Настройка

Создайте новый target

Перейдите в File > New > Target и выберите Widget Extension.

Настройка Widget Extension Введите название и убедитесь, что выбрали Include Live Activity, затем нажмите Finish.

Настройка Info.plist

Найдите файл Info.plist в основном target, вставьте ключ “Supports Live Activities” и установите для него значение YES.

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

Включение Live Activities из приложения

Чтобы включить Live Activities, добавьте их код в существующее расширение для виджетов или создайте новое, если в вашем приложении его еще нет. Live Activities используют функциональность SwiftUI и WidgetKit для своего пользовательского интерфейса. ActivityKit управляет жизненным циклом каждого Live Activity: его API используется для запроса, обновления и завершения Live Activity, а также для получения push-уведомлений ActivityKit. Вы можете узнать больше о Live Activities в документации Apple.

Перейдите к файлу ContentView вашего проекта в Xcode и создайте кнопку (Button)

import SwiftUI

struct ContentView: View {
    var body: some View {
        VStack(spacing: 20) {

            Button(action: {
                LiveActivityManager.shared.startActivity()
            }, label: {
                Text("Start Live Activity")
                    .foregroundColor(.white)
                    .padding()
                    .background(Color.blue)
                    .cornerRadius(10)
            })
        }
        .padding()
    }
}

#Preview {
    ContentView()
}

Создайте файл LiveActivityManager.swift для управления Live Activities

import Foundation
import ActivityKit
import UIKit
import PushwooshFramework
import PushwooshLiveActivities

class LiveActivityManager: NSObject, ObservableObject {
    public static let shared: LiveActivityManager = LiveActivityManager()

    private var currentActivity: Activity<FoodDeliveryAttributes>? = nil

    override init() {
        super.init()
    }

    func startActivity() {
        guard ActivityAuthorizationInfo().areActivitiesEnabled else {
            print("You can't start live activity.")
            return
        }
        do {
            let pushwooshData = PushwooshLiveActivityAttributeData(activityId: "activity_id")
            let atttribute = FoodDeliveryAttributes(orderNumber: "1234567", pushwoosh: pushwooshData)
            let initialState = FoodDeliveryAttributes.ContentState(
                status: "Preparing your meal",
                estimatedTime: "25 min",
                emoji: "👨‍🍳",
                pushwoosh: nil
            )
            let activity = try Activity<FoodDeliveryAttributes>.request(
                attributes: atttribute,
                content: .init(state:initialState , staleDate: nil),
                pushType: .token
            )
            self.currentActivity = activity

            Task {
                for await pushToken in activity.pushTokenUpdates {
                    let pushTokenString = pushToken.reduce("") {
                        $0 + String(format: "%02x", $1)
                    }
                    print("Activity:\(activity.id) push token: \(pushTokenString)")

                    // MARK: - Отправка Push-токена в Pushwoosh
                    Pushwoosh.LiveActivities.startLiveActivity(
                        token: pushTokenString,
                        activityId: "activity_id"
                    )
                }
            }
        } catch {
            print("Start Activity Error: \(error.localizedDescription)")
        }
    }
}

Вот и все, теперь мы запускаем проект и нажимаем кнопку ‘Start Live Activity’. Затем переходим на экран блокировки и видим созданный Live Activity.

Запуск Live Activity с помощью удаленного push-уведомления

Чтобы запустить Live Activity с помощью удаленного push-уведомления (Remote Push Notification), вам необходимо отправить токен pushToStartTokenUpdates в Pushwoosh.

func getPushToStartToken() {
    if #available(iOS 17.2, *) {
        Task {
            for await data in Activity<LiveActivityAttributes>.pushToStartTokenUpdates {
                let token = data.map {String(format: "%02x", $0)}.joined()
                print("Activity PushToStart Token: \(token)")

                // Отправьте токен `pushToStartTokenUpdates` в Pushwoosh
                try await Pushwoosh.LiveActivities.sendPushToStartLiveActivity(token: token)
            }
        }
    }
}

Запустите Live Activity с помощью удаленного push-уведомления

Управление Live Activities

Pushwoosh iOS SDK предоставляет следующие методы для работы с Live Activities:

// Отправка токена Live Activity Push To Start в Pushwoosh
static func sendPushToStartLiveActivity(token: String)
static func sendPushToStartLiveActivity(token: String, completion: @escaping (Error?) -> Void)

// Методы запуска Live Activity с Activity ID
static func startLiveActivity(token: String, activityId: String)
static func startLiveActivity(token: String, activityId: String, completion: @escaping (Error?) -> Void)

// Методы остановки Live Activity
static func stopLiveActivity()
static func stopLiveActivity(completion: @escaping (Error?) -> Void)

static func stopLiveActivity(activityId: String)
static func stopLiveActivity(activityId: String, completion: @escaping (Error?) -> Void)

Вы также можете обновлять live activities по сегментам, используя параметр Activity ID. При создании activity необходимо передать в метод уникальный параметр Activity ID, который будет релевантен для определенного сегмента пользователей.

Например, N пользователей подписались на одно и то же событие в live Activity. Необходимо, чтобы параметр Activity ID был уникальным для всех этих N пользователей.

Когда вы закончите работу с Live Activity, используйте эти методы:

static func stopLiveActivity()
static func stopLiveActivity(completion: @escaping (Error?) -> Void)

Метод `Setup()`

Pushwoosh упрощает передачу идентификаторов activity (activity ID), представляя функцию PushwooshLiveActivities.setup, которая управляет всем жизненным циклом Live Activity внутри приложения. Эта функция автоматически прослушивает обновления токенов pushToStart и pushToUpdate. Используя этот метод, приложению больше не нужно вручную отслеживать запуск Live Activities или управлять обновлениями токенов для обновлений activity.

Мы рекомендуем использовать этот метод, так как он берет на себя все управление токенами, что уменьшает количество кода, который вам нужно поддерживать. Это упрощает интеграцию и обеспечивает более плавную и эффективную работу вашего приложения.

В AppDelegate убедитесь, что вы импортировали PushwooshFramework и PushwooshLiveActivities и вызвали метод setup из модуля Pushwoosh.LiveActivities.

AppDelegate.swift

if #available(iOS 16.1, *) {
    Pushwoosh.LiveActivities.setup(FoodDeliveryAttributes.self)
}

FoodDeliveryAttributes

import WidgetKit
import SwiftUI
import ActivityKit
import PushwooshFramework
import PushwooshLiveActivities

struct FoodDeliveryAttributes: PushwooshLiveActivityAttributes {
    public struct ContentState: PushwooshLiveActivityContentState {
        var status: String
        var estimatedTime: String
        var emoji: String
        var pushwoosh: PushwooshLiveActivityContentStateData?
    }

    var orderNumber: String
    var pushwoosh: PushwooshLiveActivityAttributeData
}

FoodDeliveryAttributes: Эта структура соответствует протоколу PushwooshLiveActivityAttributes. Она используется для определения атрибутов live activity в приложении.

Руководство по миграции

Начиная с версии 6.8.0 Pushwoosh iOS SDK, мы обновили структуру SDK. Методы Live Activities теперь доступны через модуль PushwooshLiveActivities.

Если вы использовали версию Pushwoosh iOS SDK до 6.8.0 и вызывали перечисленные ниже методы, а затем обновились до версии 6.8.0 или более поздней, обратите внимание на следующие изменения:

static func setup<Attributes: PushwooshLiveActivityAttributes>(_ activityType: Attributes.Type)
static func defaultSetup()
static func defaultStart(_ activityId: String, attributes: [String: Any], content: [String: Any])

Теперь для доступа к этим методам следует использовать модуль LiveActivity.

import PushwooshFramework
import PushwooshLiveActivities

Pushwoosh.LiveActivities.setup(FoodDeliveryAttributes.self)
Pushwoosh.LiveActivities.defaultSetup()
Pushwoosh.LiveActivities.defaultStart("activity_id",
                            attributes: ["key_attribute": "value_attribute"],
                            content: ["key_content": "value_content"])

Мы также сохранили поддержку методов через Pushwoosh.sharedInstance(), как указано ниже, но обратите внимание, что эти методы будут объявлены устаревшими (deprecated) в будущих релизах.

// Отправка токена Live Activity Push To Start в Pushwoosh
static func sendPushToStartLiveActivity(token: String)
static func sendPushToStartLiveActivity(token: String, completion: @escaping (Error?) -> Void)

// Методы запуска Live Activity с Activity ID
static func startLiveActivity(token: String, activityId: String)
static func startLiveActivity(token: String, activityId: String, completion: @escaping (Error?) -> Void)

// Методы остановки Live Activity
static func stopLiveActivity()
static func stopLiveActivity(completion: @escaping (Error?) -> Void)

static func stopLiveActivity(activityId: String)
static func stopLiveActivity(activityId: String, completion: @escaping (Error?) -> Void)