Atividades ao vivo para Swift

Aprenda como implementar Atividades ao Vivo para o SDK Swift da Braze. Atividades ao Vivo são notificações persistentes e interativas exibidas diretamente na tela de bloqueio, permitindo que os usuários recebam atualizações dinâmicas em tempo real—sem desbloquear o dispositivo.

Como funciona

As Live Activities apresentam uma combinação de informações estáticas e dinâmicas que você atualiza. Por exemplo, você pode criar uma Live Activity que fornece um rastreador de status para uma entrega. Essa Live Activity inclui o nome da sua empresa como informação estática, além de um “Tempo para entrega” dinâmico que é atualizado conforme o motorista se aproxima do destino.

Como desenvolvedor, você pode usar a Braze para gerenciar os ciclos de vida das suas Live Activities, fazer chamadas à REST API da Braze para atualizar Live Activities e fazer com que todos os dispositivos inscritos recebam a atualização o mais rápido possível. E, como você gerencia as Live Activities pela Braze, pode usá-las em conjunto com seus outros canais de envio de mensagens — notificações por push, mensagens no app, Content Cards — para impulsionar a adoção.

Diagrama de sequência

• live activities sequence diagram

---
config:
  theme: mc
---
sequenceDiagram
  participant Server as Client Server
  participant Device as User Device
  participant App as iOS App / Braze SDK
  participant BrazeAPI as Braze API
  participant APNS as Apple Push Notification Service
  Note over Server, APNS: Launch Option 1<br/>Locally Start Activities
  App ->> App: Register a Live Activity using <br>`launchActivity(pushTokenTag:activity:)`
  App ->> App: Get push token from iOS
  App ->> BrazeAPI: Activity ID & Push token<br>automatically sent to Braze
  Note over Server, APNS: Launch Option 2<br/>Remotely Start Activities
  Device ->> App: Call `registerPushToStart`<br>to collect push tokens early
  App ->> BrazeAPI: Push-to-start tokens sent to Braze
  Server ->> BrazeAPI: POST /messages/live_activity/start
  Note right of BrazeAPI: Payload includes:<br>- push_token<br>- activity_id<br>- external_id<br>- event_name<br>- content_state (optional)
  BrazeAPI ->> APNS: Live activity start request
  APNS ->> Device: APNS sends activity to device
  App ->> App: Get push token from iOS
  App ->> BrazeAPI: Activity ID & Push token<br>automatically sent to Braze
  Note over Server, APNS: Resuming activities upon app launch
  App ->> App: Call `resumeActivities(ofType:)` on each app launch
  Note over Server, APNS: Updating a Live Activity
  loop update a live activity
  Server ->> BrazeAPI: POST /messages/live_activity/update
  Note right of BrazeAPI: Payload includes changes<br>to ContentState (dynamic variables)
  BrazeAPI ->> APNS: Update sent to APNS
  APNS ->> Device: APNS sends update to device
  end
  Note over Server, APNS: Ending a Live Activity
  Server ->> BrazeAPI: POST /messages/live_activity/update
  Note right of BrazeAPI: Activity can be ended via:<br> - User manually dismisses<br>- Times out after 12 hours<br>- Setting `end_activity: true` on `/messages/live_activity/update`
  APNS ->> Device: Live activity is dismissed

Implementando uma Live Activity

Pré-requisitos

Antes de poder usar esse recurso, você precisará integrar o Swift Braze SDK. Você também precisará concluir o seguinte:

• Certifique-se de que seu projeto esteja direcionado para iOS 16.1 ou posterior.
• Adicione o direito Push Notification em Signing & Capabilities no seu projeto Xcode.
• Certifique-se de que chaves .p8 sejam usadas para enviar notificações. Arquivos mais antigos, como .p12 ou .pem, não são compatíveis.
• A partir da versão 8.2.0 do SDK Swift da Braze, você pode registrar remotamente uma Live Activity. Para usar esse recurso, é necessário iOS 17.2 ou posterior.

Nota

Embora as Live Activities e as notificações por push sejam semelhantes, suas permissões de sistema são separadas. Por padrão, todos os recursos de Live Activity estão ativados, mas os usuários podem desativar esse recurso por app.

Etapa 1: Criar uma atividade

Primeiro, certifique-se de ter seguido Displaying live data with Live Activities na documentação da Apple para configurar Live Activities no seu aplicativo iOS. Como parte dessa tarefa, inclua NSSupportsLiveActivities definido como YES no seu Info.plist.

Como a natureza exata da sua Live Activity é específica ao seu caso de negócio, configure e inicialize os objetos Activity. É importante definir:

• ActivityAttributes: Esse protocolo define o conteúdo estático (imutável) e dinâmico (mutável) que aparece na sua Live Activity.
• ActivityAttributes.ContentState: Esse tipo define os dados dinâmicos que são atualizados ao longo da atividade.

Você também usa SwiftUI para criar a apresentação da interface na tela de bloqueio e na Dynamic Island em dispositivos compatíveis.

Certifique-se de estar familiarizado com os pré-requisitos e limitações da Apple para Live Activities, pois essas restrições são independentes da Braze.

Nota

Se você espera enviar pushes frequentes para a mesma Live Activity, pode evitar ser limitado pelo orçamento da Apple definindo NSSupportsLiveActivitiesFrequentUpdates como YES no seu arquivo Info.plist. Para saber mais, consulte a seção Determine the update frequency na documentação do ActivityKit.

Exemplo

Vamos imaginar que queremos criar uma Live Activity para fornecer aos nossos usuários atualizações sobre o show Superb Owl, onde dois centros de resgate de vida selvagem concorrentes recebem pontos pelas corujas que abrigam. Para este exemplo, criamos uma struct chamada SportsActivityAttributes, mas você pode usar sua própria implementação de ActivityAttributes.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
#if canImport(ActivityKit)
  import ActivityKit
#endif

@available(iOS 16.1, *)
struct SportsActivityAttributes: ActivityAttributes {
  public struct ContentState: Codable, Hashable {
    var teamOneScore: Int
    var teamTwoScore: Int
  }

  var gameName: String
  var gameNumber: String
}

Etapa 2: Iniciar a atividade

Primeiro, escolha como você deseja registrar sua atividade:

• Remoto: Use o método registerPushToStart no início do ciclo de vida do usuário e antes que o token push-to-start seja necessário, depois inicie uma atividade usando o endpoint /messages/live_activity/start.
• Local: Crie uma instância da sua Live Activity, depois use o método launchActivity para criar tokens por push para a Braze gerenciar.

• remoto
• local

Importante

Para registrar remotamente uma Live Activity, é necessário iOS 17.2 ou posterior.

Etapa 2.1: Adicionar o BrazeKit à sua extensão de widget

No seu projeto Xcode, selecione o nome do seu app e depois General. Em Frameworks and Libraries, confirme que BrazeKit está listado.

Etapa 2.2: Adicionar o protocolo BrazeLiveActivityAttributes

Na sua implementação de ActivityAttributes, adicione conformidade ao protocolo BrazeLiveActivityAttributes e depois adicione a propriedade brazeActivityId ao seu modelo de atributos.

Importante

O iOS mapeia a propriedade brazeActivityId para o campo correspondente no payload push-to-start da sua Live Activity, portanto ela não deve ser renomeada nem receber qualquer outro valor.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import BrazeKit

#if canImport(ActivityKit)
  import ActivityKit
#endif

@available(iOS 16.1, *)
// 1. Add the `BrazeLiveActivityAttributes` conformance to your `ActivityAttributes` struct.
struct SportsActivityAttributes: ActivityAttributes, BrazeLiveActivityAttributes {
  public struct ContentState: Codable, Hashable {
    var teamOneScore: Int
    var teamTwoScore: Int
  }

  var gameName: String
  var gameNumber: String

  // 2. Add the `String?` property to represent the activity ID.
  var brazeActivityId: String?
}

Etapa 2.3: Registrar para push-to-start

Em seguida, registre o tipo de Live Activity para que a Braze possa rastrear todos os tokens push-to-start e instâncias de Live Activity associadas a esse tipo.

Aviso

O sistema operacional iOS gera tokens push-to-start apenas durante a primeira instalação do app após a reinicialização do dispositivo. Para garantir que seus tokens sejam registrados de forma confiável, chame registerPushToStart no seu método didFinishLaunchingWithOptions.

Exemplo

No exemplo a seguir, a classe LiveActivityManager gerencia objetos de Live Activity. Depois, o método registerPushToStart registra SportsActivityAttributes:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import BrazeKit

#if canImport(ActivityKit)
  import ActivityKit
#endif

class LiveActivityManager {

  @available(iOS 17.2, *)
  func registerActivityType() {
    // This method returns a Swift background task.
    // You may keep a reference to this task if you need to cancel it wherever appropriate, or ignore the return value if you wish.
    let pushToStartObserver: Task = Self.braze?.liveActivities.registerPushToStart(
      forType: Activity<SportsActivityAttributes>.self,
      name: SportsActivityAttributes.name
    )
  }

}

Etapa 2.4: Enviar uma notificação push-to-start

Envie uma notificação remota push-to-start usando o endpoint /messages/live_activity/start.

Você pode usar o framework ActivityKit da Apple para obter um token por push, que o SDK da Braze pode gerenciar para você. Isso permite que você atualize Live Activities por meio da API da Braze, já que a Braze envia o token por push para o serviço de Notificações por Push da Apple (APN) no backend.

1. Crie uma instância da sua implementação de Live Activity usando as APIs do ActivityKit da Apple.
2. Defina o parâmetro pushType como .token.
3. Passe os ActivitiesAttributes e ContentState da Live Activity que você definiu.
4. Registre sua atividade com sua instância da Braze passando-a para launchActivity(pushTokenTag:activity:). O parâmetro pushTokenTag é uma string personalizada que você define. Ela deve ser única para cada Live Activity que você criar.

Após registrar a Live Activity, o SDK da Braze extrai e observa alterações nos tokens por push.

Exemplo

Para o nosso exemplo, crie uma classe chamada LiveActivityManager como interface para nossos objetos de Live Activity. Depois, defina o pushTokenTag como "sports-game-2024-03-15".

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import BrazeKit

#if canImport(ActivityKit)
  import ActivityKit
#endif

class LiveActivityManager {

  @available(iOS 16.2, *)
  func createActivity() {
    let activityAttributes = SportsActivityAttributes(gameName: "Superb Owl", gameNumber: "Game 1")
    let contentState = SportsActivityAttributes.ContentState(teamOneScore: "0", teamTwoScore: "0")
    let activityContent = ActivityContent(state: contentState, staleDate: nil)
    if let activity = try? Activity.request(attributes: activityAttributes,
                                            content: activityContent,
      // Setting your pushType as .token allows the Activity to generate push tokens for the server to watch.
                                            pushType: .token) {
      // Register your Live Activity with Braze using the pushTokenTag.
      // This method returns a Swift background task.
      // You may keep a reference to this task if you need to cancel it wherever appropriate, or ignore the return value if you wish.
      let liveActivityObserver: Task = AppDelegate.braze?.liveActivities.launchActivity(pushTokenTag: "sports-game-2024-03-15",
                                                                                        activity: activity)
    }
  }

}

Seu widget de Live Activity exibe esse conteúdo inicial para seus usuários.

Etapa 3: Retomar o rastreamento da atividade

Para garantir que a Braze rastreie sua Live Activity ao iniciar o app:

1. Abra seu arquivo AppDelegate.
2. Importe o módulo ActivityKit se estiver disponível.
3. Chame resumeActivities(ofType:) em application(_:didFinishLaunchingWithOptions:) para todos os tipos de ActivityAttributes que você registrou no seu aplicativo.

Isso permite que a Braze retome as tarefas para rastrear atualizações de tokens por push para todas as Live Activities ativas. Se um usuário tiver descartado explicitamente a Live Activity no dispositivo, ela é considerada removida, e a Braze não a rastreia mais.

Exemplo

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import UIKit
import BrazeKit

#if canImport(ActivityKit)
  import ActivityKit
#endif

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

  static var braze: Braze? = nil

  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {

    if #available(iOS 16.1, *) {
      Self.braze?.liveActivities.resumeActivities(
        ofType: Activity<SportsActivityAttributes>.self
      )
    }

    return true
  }
}

Etapa 4: Atualizar a atividade

O endpoint /messages/live_activity/update permite que você atualize uma Live Activity por meio de notificações por push enviadas pela REST API da Braze. Use esse endpoint para atualizar o ContentState da sua Live Activity.

Conforme você atualiza seu ContentState, o widget da Live Activity exibe as novas informações. Veja como ficou o show Superb Owl no final do primeiro tempo.

Consulte nosso artigo sobre o endpoint /messages/live_activity/update para detalhes completos.

Etapa 5: Encerrar a atividade

Quando uma Live Activity está ativa, ela é exibida tanto na tela de bloqueio do usuário quanto na Dynamic Island. Para encerrá-la pela Braze, use o endpoint /messages/live_activity/update com end_activity definido como true.

Para melhorar a confiabilidade ao encerrar uma Live Activity, siga estas etapas opcionais:

1. Opcionalmente, inclua dismissal_date na mesma requisição de update para sugerir quando o iOS deve remover a interface da Live Activity.
2. Verifique os resultados de entrega no Message Activity Log.

Organizando o encerramento automático

Para organizar o encerramento automático, agende uma requisição de acompanhamento para o endpoint de atualização após iniciar a Live Activity.

1. Envie uma requisição /messages/live_activity/start com um activity_id que você possa rastrear.
2. Armazene esse activity_id e o horário de encerramento desejado no seu agendador de backend.
3. No horário de encerramento desejado, envie uma requisição /messages/live_activity/update com end_activity definido como true.
4. Configure a data de encerramento na mesma requisição de atualização. Para saber mais, consulte o endpoint /messages/live_activity/update.

O controle do momento do encerramento é feito pelo iOS. Mesmo após o envio de uma requisição de encerramento válida, a remoção da tela de bloqueio ou da Dynamic Island pode ser atrasada ou se comportar de forma diferente com base nas condições do sistema operacional.

Uma Live Activity também pode ser encerrada fora da Braze:

• Encerramento pelo usuário: Um usuário pode descartar manualmente uma Live Activity.
• Tempo esgotado: Após um tempo padrão de oito horas, o iOS remove a Live Activity da Dynamic Island do usuário. Após um tempo padrão de 12 horas, o iOS remove a Live Activity da tela de bloqueio do usuário.

Consulte nosso artigo sobre o endpoint /messages/live_activity/update para detalhes completos.

Rastreamento de Live Activities

Os eventos de Live Activity estão disponíveis no Currents, no Snowflake Data Sharing e no Query Builder. Os eventos a seguir podem ajudar você a entender e monitorar o ciclo de vida das suas Live Activities, rastrear a disponibilidade de tokens e diagnosticar problemas ou verificar status de entrega de forma independente.

• Alteração de token Push To Start de Live Activity: Captura quando um token push-to-start (PTS) é adicionado ou atualizado na Braze, permitindo rastrear registros e disponibilidade de tokens por usuário.
• Alteração de token de atualização de Live Activity: Rastreia a adição, atualização ou remoção de tokens de atualização de Live Activity (LAU).
• Envio de Live Activity: Registra cada vez que uma Live Activity é iniciada, atualizada ou encerrada pela Braze.
• Resultado de Live Activity: Indica o status final de entrega ao serviço de Notificações por Push da Apple (APN) para cada Live Activity enviada a partir da Braze.

Verificar envios de Live Activity

Se você precisar confirmar se um espaço de trabalho está enviando iOS Live Activities, pode usar os seguintes métodos:

Registro de atividade de mensagens

Acesse Configurações > Registro de atividade de mensagens e filtre por erros de Live Activity para ver quaisquer resultados de entrega relacionados a Live Activity durante o período esperado. Para saber mais, consulte Registro de atividade de mensagens.

Query Builder, Currents ou compartilhamento de dados do Snowflake

Verifique os seguintes eventos de Live Activity para confirmar o ciclo de vida e a entrega da Live Activity:

• Live Activity Send: Registrado cada vez que uma Live Activity é iniciada, atualizada ou encerrada pela Braze
• Live Activity Outcome: Status final de entrega para o APN para cada Live Activity enviada

Opcionalmente, você também pode verificar sinais de disponibilidade de token:

• Live Activity Push To Start Token Change
• Live Activity Update Token Change

Dashboard de uso de API

Acesse Configurações > APIs e identificadores > Dashboard, selecione Filtros e filtre por Endpoint para ver as respostas da API. Por exemplo, selecione /messages/live_activity/update (ou /messages/live_activity/start) e visualize o volume de solicitações nos últimos 30 dias. As respostas da API indicam que a API está sendo chamada e que as notificações de iOS Live Activity estão sendo usadas neste espaço de trabalho. Para saber mais, consulte Dashboard de uso de API.

Observar eventos de Atividade ao Vivo (opcional)

Importante

Não se inscreva diretamente nesses streams do ActivityKit com a Apple, pois isso entrará em conflito com as inscrições da Braze e impedirá que as Atividades ao Vivo funcionem corretamente:

1. pushTokenUpdates
2. activityStateUpdates
3. contentUpdates
4. pushToStartTokenUpdates
5. activityUpdates

Em vez disso, use as inscrições mencionadas nesta seção.

O SDK da Braze fornece dois métodos de inscrição em braze.liveActivities para observar o ciclo de vida completo das Atividades ao Vivo. Para um passo a passo completo, consulte o tutorial de Atividades ao Vivo.

• subscribeToStateUpdates(_:): Entrega eventos de ciclo de vida tanto para o registro de tokens push-to-start quanto para instâncias de atividades em execução.
• subscribeToErrors(_:): Entrega erros do SDK e do lado do servidor encontrados durante o rastreamento de Atividades ao Vivo.

Nota

Ambos os métodos retornam um Braze.Cancellable. A inscrição permanece ativa enquanto o valor retornado for mantido por uma referência forte (por exemplo, armazene-o em uma propriedade com o mesmo ciclo de vida da sua instância Braze).

Configurar inscrições

Configure as inscrições uma vez em application(_:didFinishLaunchingWithOptions:) e mantenha-as durante toda a vida útil do seu app:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class AppDelegate: UIResponder, UIApplicationDelegate {
  static var braze: Braze?

  var stateSubscription: Braze.Cancellable?
  var errorSubscription: Braze.Cancellable?

  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    let braze = Braze(configuration: config)
    Self.braze = braze

    if #available(iOS 16.1, *) {
      stateSubscription = Self.braze?.liveActivities.subscribeToStateUpdates { event in
        self.handleStateUpdate(event)
      }
      errorSubscription = Self.braze?.liveActivities.subscribeToErrors { error in
        self.handleLiveActivityError(error)
      }
    }

    return true
  }
}

Nota

Os retornos de chamada são acionados apenas para eventos futuros de atividades ao vivo — eles não reproduzem o estado atual no momento da inscrição. Para consultar o snapshot do estado atual, use Activity<T>.activities.

subscribeToStateUpdates

subscribeToStateUpdates(_:) entrega valores UpdateEvent que cobrem o ciclo de vida completo das Atividades ao Vivo. Os eventos são divididos em dois escopos:

• .activityType(ActivityType): Eventos em nível de tipo para registro de tokens push-to-start (iOS 17.2+). Nenhuma instância de atividade existe ainda.
• .activityInstance(ActivityInstance): Eventos em nível de instância para uma atividade específica em execução.

Múltiplos assinantes são suportados — cada inscrição ativa recebe cada emissão de forma independente.

Eventos com escopo de tipo

Eventos com escopo de instância

Exemplo

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
func handleStateUpdate(_ event: Braze.LiveActivities.UpdateEvent) {
  switch event {

  // Type-scoped: push-to-start token lifecycle (iOS 17.2+)
  case .activityType(.pushToStartTokenRead(let activityType)):
    print("[\(activityType)] Push-to-start token read by SDK")

  // ...

  // Instance-scoped: SDK tracking
  case .activityInstance(.started(let id, let type, let tag, let source)):
    print("[\(type)] Activity \(id) started via \(source), tag: \(tag)")

  // ...

  // Instance-scoped: ActivityKit lifecycle
  case .activityInstance(.active(let id, let type)):
    print("[\(type)] Activity \(id) is active")

  // ...

  case .activityInstance(.ended(let id, let type)):
    print("[\(type)] Activity \(id) ended")

  // Instance-scoped: content updates (iOS 16.2+)
  case .activityInstance(.contentUpdated(let id, let type)):
    // For more advanced use cases of `contentUpdated`, see the section below
    print("[\(type)] Content updated for activity \(id)")

  case .activityInstance(.pushTokenUpdated(let id, let type)):
    print("[\(type)] Activity \(id) push token rotated")
  }
}

subscribeToErrors

subscribeToErrors(_:) entrega valores ErrorEvent usando os mesmos dois escopos que UpdateEvent:

• .activityType(ActivityType): Erros em nível de tipo para falhas de registro push-to-start.
• .activityInstance(ActivityInstance): Erros em nível de instância para uma atividade em execução.

Use a flag isTransient para determinar se uma nova tentativa é apropriada. O SDK tenta novamente automaticamente as falhas transitórias.

Erros com escopo de tipo

Erros com escopo de instância

Exemplo

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
func handleLiveActivityError(_ error: Braze.LiveActivities.ErrorEvent) {
  switch error {

  // Type-scoped errors
  case .activityType(.pushToStartRegistrationFailed(let type, let isTransient, let reason)):
    if isTransient {
      print("[\(type)] Push-to-start registration failed (transient, will retry): \(reason)")
    } else {
      print("[\(type)] Push-to-start registration failed (permanent): \(reason)")
    }

  // Instance-scoped errors
  case .activityInstance(.registrationFailed(let id, let type, _, let isTransient, let reason)):
    if isTransient {
      print("[\(type)] Activity \(id) registration failed (transient, retrying): \(reason)")
    } else {
      print("[\(type)] Activity \(id) registration failed (permanent): \(reason)")
    }

  case .activityInstance(.activityNotFound(let id, let type)):
    print("[\(type)] Stored activity \(id) not found on resume")

  case .activityInstance(.invalidPushTokenTag(let id, let type, let tag)):
    print("[\(type)] Activity \(id) has invalid push token tag '\(tag)'")
  }
}

Lidar com atualizações de estado do conteúdo (opcional)

Se você quiser usar o estado do conteúdo da instância real da Atividade ao Vivo, siga esta seção.

Quando um evento .contentUpdated é disparado, use lógica personalizada para buscar a Activity<T> em execução pelo seu ID em Activity.activities e, em seguida, acesse o ContentState tipado por meio de activity.content.state.

Tipo de atributos único

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
case .activityInstance(.contentUpdated(let id, let type)):
  #if canImport(ActivityKit)
    // Add custom logic look up the Activity<T> by ID and access your app's typed ContentState.
    // In this example, `SportsActivityAttributes` is the app's custom type.
    if #available(iOS 16.2, *),
      let activity = findActivityInstance(id: id, as: SportsActivityAttributes.self)
    {
      // `activityContent` is now strongly typed as a `SportsActivityAttributes`
      let activityContent = activity.content.state
      print("[\(type)] Game \(id) — score: \(activityContent.teamOneScore)–\(activityContent.teamTwoScore)")
      return
    }
  #endif
  print("[\(type)] Content updated for activity \(id)")

// ...

// - MARK: Helper methods

@available(iOS 16.2, *)
func findActivityInstance<Attributes: ActivityAttributes>(
  id: String,
  as type: Attributes.Type
) -> Activity<Attributes>? {
  // Use Apple's API to find the matching Live Activity instance:
  // - https://developer.apple.com/documentation/activitykit/activity/activities
  Activity<Attributes>.activities.first(where: { $0.id == id })
}

Múltiplos tipos de atributos

Se o seu app usa múltiplos tipos de ActivityAttributes, verifique a string type para buscar a Activity<T> apropriada:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
case .activityInstance(.contentUpdated(let id, let type)):
  #if canImport(ActivityKit)
    if #available(iOS 16.2, *) {
      if type == SportsActivityAttributes.name,
        let activity = findActivityInstance(id: id, as: SportsActivityAttributes.self)
      {
        let activityContent = activity.content.state
        print("[\(type)] Game \(id) — score: \(activityContent.teamOneScore)–\(activityContent.teamTwoScore)")
        return

      } else if type == OrderActivityAttributes.name,
        let activity = findActivityInstance(id: id, as: OrderActivityAttributes.self)
      {
        let activityContent = activity.content.state
        print("[\(type)] Order \(id) — status: \(activityContent.status), ETA: \(activityContent.eta)")
        return
      }
    }
  #endif
  print("[\(type)] Content updated for activity \(id)")

// ...

// - MARK: Helper methods

@available(iOS 16.2, *)
func findActivityInstance<Attributes: ActivityAttributes>(
  id: String,
  as type: Attributes.Type
) -> Activity<Attributes>? {
  // Use Apple's API to find the matching Live Activity instance:
  // - https://developer.apple.com/documentation/activitykit/activity/activities
  Activity<Attributes>.activities.first(where: { $0.id == id })
}

Perguntas frequentes (FAQ)

Funcionalidade e suporte

Quais plataformas suportam Atividades ao Vivo?

Atualmente, as Atividades ao Vivo são um recurso específico do iOS e iPadOS. Por padrão, atividades lançadas em um iPhone ou iPad também são exibidas em qualquer dispositivo watchOS 11+ ou macOS 26+ emparelhado.

A Braze não oferece suporte nativo a Atividades ao Vivo no Android no momento. Para Android, você pode criar experiências de atualização em tempo real por meio de notificações por push da Braze e renderização personalizada de notificações.

O artigo sobre Atividades ao Vivo aborda os pré-requisitos para o gerenciamento de Atividades ao Vivo por meio do SDK Swift da Braze.

Os apps React Native são compatíveis com Atividades ao Vivo?

Sim, o React Native SDK 3.0.0+ oferece suporte a Atividades ao Vivo por meio do SDK Swift da Braze. Ou seja, você precisa escrever código React Native iOS diretamente sobre o SDK Swift da Braze.

Não há uma API de conveniência JavaScript específica do React Native para Atividades ao Vivo porque os recursos de Atividades ao Vivo fornecidos pela Apple usam linguagens intraduzíveis em JavaScript (por exemplo, concorrência Swift, genéricos, SwiftUI).

A Braze oferece suporte a Atividades ao Vivo como uma Campaign ou etapa do Canvas?

Não, isso não é suportado no momento.

Notificações por push e Atividades ao Vivo

O que acontece se uma notificação por push for enviada enquanto uma Atividade ao Vivo estiver ativa?

As Atividades ao Vivo e as notificações por push ocupam espaços diferentes na tela e não entram em conflito na tela do usuário.

Se as Atividades ao Vivo utilizam a funcionalidade de mensagens push, as notificações por push precisam estar ativadas para receber Atividades ao Vivo?

Embora as Atividades ao Vivo dependam de notificações por push para atualizações, elas são controladas por configurações de usuário diferentes. Um usuário pode aceitar Atividades ao Vivo, mas não as notificações por push, e vice-versa.

Os tokens de atualização de Atividade ao Vivo expiram após oito horas.

As Atividades ao Vivo requerem push primers?

Os push primers são uma prática recomendada para solicitar que os usuários aceitem notificações por push do seu app. No entanto, não há nenhum prompt do sistema para aceitar Atividades ao Vivo. Por padrão, os usuários aceitam Atividades ao Vivo para um app individual quando instalam esse app no iOS 16.1 ou posterior. Essa permissão pode ser desativada ou reativada nas configurações do dispositivo por app.

Tópicos técnicos e solução de problemas

Como posso saber se as Atividades ao Vivo têm erros?

Todos os erros de Atividades ao Vivo são registrados no dashboard da Braze no Registro de atividades de envio de mensagem, onde é possível filtrar por “LiveActivity Errors”.

Depois de enviar uma notificação push-to-start, por que não recebi minha Atividade ao Vivo?

Primeiro, verifique se sua carga útil inclui todos os campos obrigatórios descritos no endpoint messages/live_activity/start. Os campos activity_attributes e content_state devem corresponder às propriedades definidas no código do seu projeto. Se tiver certeza de que a carga útil está correta, é possível que você esteja sendo limitado pelos APNs. Esse limite é imposto pela Apple e não pela Braze.

Para verificar se a notificação push-to-start chegou com sucesso ao dispositivo, mas não foi exibida devido a limites de taxa, você pode depurar o projeto usando o app Console no Mac. Anexe o processo de gravação do dispositivo desejado e, em seguida, filtre os registros por process:liveactivitiesd na barra de pesquisa.

Depois de iniciar minha Atividade ao Vivo com push-to-start, por que ela não está recebendo novas atualizações?

Verifique se você implementou corretamente as instruções na Etapa 2.2: Adicionar o protocolo BrazeLiveActivityAttributes. Seu ActivityAttributes deve conter tanto a conformidade com o protocolo BrazeLiveActivityAttributes quanto a propriedade brazeActivityId.

Depois de receber uma notificação push-to-start de Atividade ao Vivo, verifique se você consegue ver uma solicitação de rede de saída para o endpoint /push_token_tag da sua URL da Braze e se ela contém o ID da atividade correto no campo "tag".

Por fim, certifique-se de que o tipo de atributo da Atividade ao Vivo na sua carga útil de atualização corresponda exatamente à string e à classe usadas na chamada do método do SDK para registerPushToStart. Use constantes para evitar erros de digitação.

Estou recebendo uma resposta de acesso negado quando tento usar o endpoint live_activity/update. Por quê?

As chaves de API que você usa precisam ter as permissões corretas para acessar os diferentes endpoints da API da Braze. Se estiver usando uma chave de API criada anteriormente, é possível que tenha se esquecido de atualizar as permissões. Leia nossa visão geral da segurança da chave de API para relembrar.

O endpoint messages/send compartilha os limites de taxa com o endpoint messages/live_activity/update?

Por padrão, o limite de taxa do endpoint messages/live_activity/update é de 250.000 solicitações por hora, por espaço de trabalho e em vários endpoints. Consulte os limites de taxa da API para saber mais.