Integração push

Etapa 1: Configurar notificações por push

Antes de poder enviar uma notificação por push iOS usando a Braze, você precisa fornecer seu .p8 arquivo de notificação por push fornecido pela Apple. Conforme descrito na documentação do desenvolvedor da Apple:

1. Em sua conta de desenvolvedor Apple, acessar Certificados, Identificadores e Perfis.
2. Em Chaves, selecione Todos e clique no botão adicionar (+) no canto superior direito.
3. Em Descrição da Chave, insira um nome único para a chave de assinatura.
4. Em Serviços Principais, selecione a caixa de seleção serviço de Notificações por Push da Apple (APNs), depois clique em Continuar. Clique Confirmar.
5. Note o ID da chave. Clique em baixar para gerar e baixar a chave. Certifique-se de salvar o arquivo baixado em um local seguro, pois você não pode baixar isso mais de uma vez.
6. Na Braze, acesse Configurações > Configurações do app e faça upload do arquivo .p8 em Certificado de push da Apple. Você pode fazer upload do seu certificado de push de desenvolvimento ou de produção. Para testar notificações por push depois que seu app estiver disponível na App Store, é recomendável configurar um espaço de trabalho separado para a versão de desenvolvimento do seu app.
7. Quando solicitado, informe o ID do pacote, o ID da chave e o ID da equipe e clique em Salvar.

Etapa 2: Ativar os recursos de push

Nas configurações do projeto, certifique-se de que, na guia Recursos, o recurso de notificações por push esteja ativado.

Se tiver certificados push de desenvolvimento e produção separados, desmarque a caixa Gerenciar automaticamente o login na guia Geral. Isso permitirá que você escolha diferentes perfis de provisionamento para cada configuração de compilação, pois o recurso de assinatura automática de código do Xcode só faz a assinatura de desenvolvimento.

Etapa 3: Registre-se para receber notificações por push

O exemplo de código apropriado deve ser incluído no método delegado application:didFinishLaunchingWithOptions: do seu app para que o dispositivo dos seus usuários se registre com APNs. Chame todo o código de integração push na thread principal do app.

Braze também fornece categorias de push padrão para suporte ao botão de ação por push, que devem ser adicionadas manualmente ao seu código de registro de push. Consulte os botões de ação por push para obter etapas adicionais de integração.

Usando a estrutura UserNotification (iOS 10+)

Se estiver usando o framework UserNotifications (recomendado) lançado no iOS 10, adicione o seguinte código ao método application:didFinishLaunchingWithOptions: do delegado do seu app.

• objective c
• swift

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_9_x_Max) {
  UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
  center.delegate = self;
  UNAuthorizationOptions options = UNAuthorizationOptionAlert | UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
  if (@available(iOS 12.0, *)) {
  options = options | UNAuthorizationOptionProvisional;
  }
  [center requestAuthorizationWithOptions:options
                        completionHandler:^(BOOL granted, NSError * _Nullable error) {
                          [[Appboy sharedInstance] pushAuthorizationFromUserNotificationCenter:granted];
  }];
  [[UIApplication sharedApplication] registerForRemoteNotifications];
} else {
  UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:(UIUserNotificationTypeBadge | UIUserNotificationTypeAlert | UIUserNotificationTypeSound) categories:nil];
  [[UIApplication sharedApplication] registerForRemoteNotifications];
  [[UIApplication sharedApplication] registerUserNotificationSettings:settings];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
if #available(iOS 10, *) {
  let center = UNUserNotificationCenter.current()
  center.delegate = self as? UNUserNotificationCenterDelegate
  var options: UNAuthorizationOptions = [.alert, .sound, .badge]
  if #available(iOS 12.0, *) {
    options = UNAuthorizationOptions(rawValue: options.rawValue | UNAuthorizationOptions.provisional.rawValue)
  }
  center.requestAuthorization(options: options) { (granted, error) in
    Appboy.sharedInstance()?.pushAuthorization(fromUserNotificationCenter: granted)
  }
  UIApplication.shared.registerForRemoteNotifications()
} else {
  let types : UIUserNotificationType = [.alert, .badge, .sound]
  let setting : UIUserNotificationSettings = UIUserNotificationSettings(types:types, categories:nil)
  UIApplication.shared.registerUserNotificationSettings(setting)
  UIApplication.shared.registerForRemoteNotifications()
}

Sem a estrutura UserNotifications

Se não estiver usando o framework UserNotifications, adicione o seguinte código ao método application:didFinishLaunchingWithOptions: do delegado do seu app:

• objective c
• swift

1
2
3
UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:(UIUserNotificationTypeBadge | UIUserNotificationTypeAlert | UIUserNotificationTypeSound) categories:nil];
[[UIApplication sharedApplication] registerForRemoteNotifications];
[[UIApplication sharedApplication] registerUserNotificationSettings:settings];

1
2
3
4
let types : UIUserNotificationType = UIUserNotificationType.Badge | UIUserNotificationType.Sound | UIUserNotificationType.Alert
var setting : UIUserNotificationSettings = UIUserNotificationSettings(forTypes: types, categories: nil)
UIApplication.shared.registerUserNotificationSettings(setting)
UIApplication.shared.registerForRemoteNotifications()

Etapa 4: Registrar tokens por push na Braze

Quando o registro de APNs estiver concluído, o método a seguir deverá ser alterado para passar o deviceToken resultante para o Braze, de modo que o usuário fique capacitado para notificações por push:

• objective c
• swift

1
[[Appboy sharedInstance] registerDeviceToken:deviceToken];

1
Appboy.sharedInstance()?.registerDeviceToken(deviceToken)

Etapa 5: Ativar push handling

O código a seguir passa as notificações por push recebidas para o Braze e é necessário para o registro da análise por push e o tratamento de links. Certifique-se de chamar todo o código de integração push na thread principal do seu aplicativo.

iOS 10+

Ao desenvolver para iOS 10 ou posteriores, recomendamos integrar o framework UserNotifications e fazer o seguinte:

• objective c
• swift

1
2
3
[[Appboy sharedInstance] registerApplication:application
                didReceiveRemoteNotification:userInfo
                      fetchCompletionHandler:completionHandler];

1
2
3
[[Appboy sharedInstance] userNotificationCenter:center
                 didReceiveNotificationResponse:response
                          withCompletionHandler:completionHandler];

1
2
3
4
5
6
7
8
9
- (void)userNotificationCenter:(UNUserNotificationCenter *)center
       willPresentNotification:(UNNotification *)notification
         withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler {
  if (@available(iOS 14.0, *)) {
    completionHandler(UNNotificationPresentationOptionList | UNNotificationPresentationOptionBanner);
  } else {
    completionHandler(UNNotificationPresentationOptionAlert);
  }
}

1
2
3
Appboy.sharedInstance()?.register(application,
                                            didReceiveRemoteNotification: userInfo,
                                            fetchCompletionHandler: completionHandler)

1
2
3
Appboy.sharedInstance()?.userNotificationCenter(center,
                                               didReceive: response,
                                               withCompletionHandler: completionHandler)

1
2
3
4
5
6
7
8
9
func userNotificationCenter(_ center: UNUserNotificationCenter,
                              willPresent notification: UNNotification,
                              withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
  if #available(iOS 14.0, *) {
    completionHandler([.list, .banner]);
  } else {
    completionHandler([.alert]);
  }
}

Pré-iOS 10

O iOS 10 atualizou o comportamento de modo que não chama mais application:didReceiveRemoteNotification:fetchCompletionHandler: quando um push é clicado. Por isso, se você não atualizar o desenvolvimento para o iOS 10 e posteriores e usar o framework UserNotifications, terá que chamar a Braze a partir de ambos os delegados de estilo antigo, que é uma ruptura com a nossa integração anterior.

Para apps desenvolvidos com SDKs anteriores ao iOS 10, use as seguintes instruções:

• objective c
• swift

1
2
3
[[Appboy sharedInstance] registerApplication:application
                didReceiveRemoteNotification:userInfo
                      fetchCompletionHandler:completionHandler];

1
2
[[Appboy sharedInstance] registerApplication:application
                didReceiveRemoteNotification:userInfo];

1
2
3
Appboy.sharedInstance()?.register(application,
  didReceiveRemoteNotification: userInfo,
  fetchCompletionHandler: completionHandler)

1
2
Appboy.sharedInstance()?.register(application,
  didReceiveRemoteNotification: userInfo)

Etapa 6: Deep linking

Deep linking de um push para o app é automaticamente tratado por meio da nossa documentação padrão de integração de push. Se quiser saber mais sobre como adicionar deep links a locais específicos em seu app, consulte nossos casos de uso avançados.

Etapa 7: Testes de unidade (opcional)

Para adicionar cobertura de teste para as etapas de integração que você acabou de seguir, implemente testes unitários push.