Stories por push

Pré-requisitos

Antes de poder usar esse recurso, você precisará integrar o Swift Braze SDK. Você também precisará configurar notificações por push, o que inclui a implementação do framework UNNotification.

A seguinte versão mínima do SDK é necessária para receber Push Stories:

Configurando Push Stories

Etapa 1: Adicionando o alvo da extensão de conteúdo de notificação

No seu projeto de app, acesse o menu File > New > Target e adicione um novo alvo Notification Content Extension e ative-o.

O Xcode deve gerar um novo alvo e criar arquivos automaticamente para você, incluindo:

• NotificationViewController.swift
• MainInterface.storyboard

Etapa 2: Ativar capacidades

No Xcode, adicione a capacidade Background Modes usando o painel Signing & Capabilities ao alvo principal do app. Selecione as caixas de seleção Background fetch e Remote notifications.

Adicionando um grupo de app

Além disso, no painel Signing & Capabilities no Xcode, adicione a capacidade App Groups ao alvo principal do seu app, bem como aos alvos da extensão de conteúdo de notificação. Em seguida, clique no botão +. Use o ID do pacote do seu app para criar o grupo de app. Por exemplo, se o ID do pacote do seu app for com.company.appname, você pode nomear seu grupo de app group.com.company.appname.xyz.

Importante

Grupos de app neste contexto referem-se à App Groups Entitlement da Apple e não ao seu ID de espaço de trabalho da Braze (anteriormente grupo de app).

Se você não adicionar seu app a um grupo de app, seu app pode falhar em preencher certos campos da carga útil do push e não funcionará totalmente como esperado.

Etapa 3: Adicionando o framework de Push Story ao seu app

• swift package manager
• cocoapods
• manual

Depois de seguir o guia de integração do Swift Package Manager, adicione BrazePushStory ao seu Notification Content Extension:

Adicione a seguinte linha ao seu Podfile:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
target 'YourAppTarget' do
pod 'BrazeKit'
pod 'BrazeUI'
pod 'BrazeLocation'
end

target 'YourNotificationContentExtensionTarget' do
pod 'BrazePushStory'
end

# Only include the below if you want to also integrate Rich Push
target 'YourNotificationServiceExtensionTarget' do
pod 'BrazeNotificationService'
end

Nota

Para obter instruções sobre como implementar Rich Push, consulte Notificações Rich.

Após atualizar o Podfile, navegue até o diretório do seu projeto de app Xcode no terminal e execute pod install.

Baixe o último BrazePushStory.zip da página de lançamentos do GitHub, extraia-o e adicione o BrazePushStory.xcframework à Notification Content Extension do seu projeto.

Importante

Certifique-se de que Do Not Embed esteja selecionado para BrazePushStory.xcframework na coluna Embed.

Etapa 4: Atualizando seu controlador de visualização de notificações

Em NotificationViewController.swift, adicione a seguinte linha para importar os arquivos de cabeçalho:

1
import BrazePushStory

Em seguida, substitua a implementação padrão herdando BrazePushStory.NotificationViewController:

1
class NotificationViewController: BrazePushStory.NotificationViewController {}

Tratamento personalizado de eventos de story por push

Se você quiser implementar sua própria lógica personalizada para lidar com eventos de notificação de story por push, herde BrazePushStory.NotificationViewController como acima e substitua os métodos didReceive como abaixo.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import BrazePushStory
import UserNotifications
import UserNotificationsUI

class NotificationViewController: BrazePushStory.NotificationViewController {
  override func didReceive(_ notification: UNNotification) {
    super.didReceive(notification)

    // Custom handling logic
  }

  override func didReceive(_ response: UNNotificationResponse, completionHandler completion: @escaping (UNNotificationContentExtensionResponseOption) -> Void) {
    super.didReceive(response, completionHandler: completion)

    // Custom handling logic
  }
}

Etapa 5: Configurando o plist da extensão de conteúdo de notificação

Abra o arquivo Info.plist da Notification Content Extension, depois adicione e altere as seguintes chaves em NSExtension \ NSExtensionAttributes:

Além disso, adicione o seguinte dicionário Braze de nível superior ao mesmo arquivo Info.plist, substituindo REPLACE_WITH_APPGROUP pelo grupo de app que você criou na Etapa 2:

Seu arquivo Info.plist deve corresponder à seguinte imagem:

Etapa 6: Atualizando a integração da Braze no seu app principal

Antes de inicializar a Braze, atribua o nome do seu grupo de app à propriedade push.appGroup da configuração da Braze.

1
2
3
4
let configuration = Braze.Configuration(apiKey: "<YOUR-BRAZE-API-KEY>",
                                        endpoint: "<YOUR-BRAZE-ENDPOINT>")
configuration.push.appGroup = "REPLACE_WITH_APPGROUP"
let braze = Braze(configuration: configuration)