Live Activities в iOS

Совет

Посмотрите видео о Live Activities в iOS

Видео на YouTube: Live Activities в iOS

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

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

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

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

Настройка

Важно

Live Activities в Pushwoosh поддерживают только конфигурацию на основе токенов. Конфигурация на основе сертификатов не поддерживается.

Добавление расширения для виджетов

1. Создайте новый таргет

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

2. Конфигурация расширения для виджетов Введите имя и убедитесь, что выбрали Include Live Activity, затем нажмите Finish.

Конфигурация Info.plist

Найдите файл Info.plist в основном таргете, вставьте ключ “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.

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

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()
}

2. Создайте файл 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: - Send Push Token to Pushwoosh
                    Pushwoosh.LiveActivities.startLiveActivity(
                        token: pushTokenString,
                        activityId: "activity_id"
                    )
                }
            }
        } catch {
            print("Start Activity Error: \(error.localizedDescription)")
        }
    }
}

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

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

1. Чтобы запустить Live Activity через удаленное push-уведомление, вам нужно отправить токен 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)")

                // Send `pushToStartTokenUpdates` token to Pushwoosh
                try await Pushwoosh.LiveActivities.sendPushToStartLiveActivity(token: token)
            }
        }
    }
}

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

Совет

Следуйте нашей справке по API Pushwoosh для получения инструкций и примеров по созданию запроса на удаленный запуск Live Activity.

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

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

// Send Live Activity Push To Start Token to Pushwoosh
static func sendPushToStartLiveActivity(token: String)
static func sendPushToStartLiveActivity(token: String, completion: @escaping (Error?) -> Void)

// Start Live Activity Methods with Activity ID
static func startLiveActivity(token: String, activityId: String)
static func startLiveActivity(token: String, activityId: String, completion: @escaping (Error?) -> Void)

// Stop Live Activity Methods
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 ID, который будет релевантен для определенного сегмента пользователей.

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

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

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

Примечание

Вы можете управлять Live Activities в iOS через Pushwoosh API.

Метод Setup().

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

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

В 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 в приложении.

Примечание

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

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

Начиная с версии 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(), как указано ниже, но обратите внимание, что эти методы будут устаревшими в будущих релизах.

// Send Live Activity Push To Start Token to Pushwoosh
static func sendPushToStartLiveActivity(token: String)
static func sendPushToStartLiveActivity(token: String, completion: @escaping (Error?) -> Void)

// Start Live Activity Methods with Activity ID
static func startLiveActivity(token: String, activityId: String)
static func startLiveActivity(token: String, activityId: String, completion: @escaping (Error?) -> Void)

// Stop Live Activity Methods
static func stopLiveActivity()
static func stopLiveActivity(completion: @escaping (Error?) -> Void)

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