Implemente as extensões de serviço de notificação iOS e Android em seu aplicativo.
As Extensões de Serviço de Notificação permitem que você intercepte e modifique notificações push antes de serem exibidas ao usuário. Isso habilita o manuseio de dados em segundo plano, estilos personalizados, anexos de rich media, entrega confirmada e opções de botões de ação.
Você pode acessar os dados em suas notificações push enviadas do OneSignal através da classe OSNotification
Permite que você processe a notificação antes de ser mostrada ao usuário. Casos de uso comuns incluem:
Receber dados em segundo plano com ou sem exibir uma notificação.
Substituir configurações específicas de notificação dependendo da lógica do aplicativo do lado do cliente, como cor de destaque personalizada, padrão de vibração ou qualquer outra opção NotificationCompat disponível.
Passo 1: Criar uma classe para a extensão de serviço
Crie uma classe que implementa INotificationServiceExtension e implemente o método onNotificationReceived.O parâmetro do método onNotificationReceived é event do tipo INotificationReceivedEvent.
package your.package.nameimport androidx.annotation.Keep;import com.onesignal.notifications.IActionButton;import com.onesignal.notifications.IDisplayableMutableNotification;import com.onesignal.notifications.INotificationReceivedEvent;import com.onesignal.notifications.INotificationServiceExtension;@Keep // Keep is required to prevent minification from renaming or removing your classpublic class NotificationServiceExtension implements INotificationServiceExtension { @Override public void onNotificationReceived(INotificationReceivedEvent event) { IDisplayableMutableNotification notification = event.getNotification(); if (notification.getActionButtons() != null) { for (IActionButton button : notification.getActionButtons()) { // you can modify your action buttons here } } /* Add customizations here. See examples below for additional methods to modify the notification*/ }}
A anotação @Keep é necessária para evitar que o ProGuard ou o R8 renomeie ou remova sua classe durante a minificação.
Os exemplos a seguir mostram personalizações comuns que você pode implementar na classe de Extensão de Serviço de Notificação.
Impedir que a notificação seja exibida
Adicionar um campo personalizado
Alterar a cor e o ícone da notificação
Use event.preventDefault() para suprimir a exibição da notificação. Em seguida, você pode chamar event.getNotification().display() para exibi-la mais tarde, ou nunca chamá-la para descartá-la silenciosamente.
event.preventDefault();//Do some async work, then decide to show or dismissnew Thread(() -> { try { Thread.sleep(1000); } catch (InterruptedException ignored) {} //Manually show the notification event.getNotification().display();}).start();
Chamar event.preventDefault() sem nunca chamar display() descartará a notificação silenciosamente. Se a intenção for suprimir permanentemente, isso é esperado. Para mais informações, consulte Notificações duplicadas.
Passo 3: Adicionar a extensão de serviço ao seu AndroidManifest.xml
Adicione o nome da classe e o valor como meta-data dentro do arquivo AndroidManifest.xml na tag do aplicativo. Ignore quaisquer avisos de “não utilizado”.
A UNNotificationServiceExtension permite que você modifique o conteúdo das notificações push antes de serem exibidas ao usuário e é necessária para outros recursos importantes como:
Você provavelmente já configurou isso se seguiu nossas instruções de configuração do SDK Móvel para seu aplicativo, mas esta seção explicará como acessar os dados de payload de notificação do OneSignal e solucionar quaisquer problemas que você possa estar tendo.
O override didReceive(_:withContentHandler:) chama OneSignalExtension.didReceiveNotificationExtensionRequest, que passa o bestAttemptContent para o OneSignal antes de ser exibido ao usuário. Você pode ler ou modificar bestAttemptContent antes que esse método seja chamado.Neste exemplo, enviamos uma notificação com os seguintes dados:
Acesse estes data adicionais dentro da OneSignalNotificationServiceExtension através da chave a dentro do dicionário custom de userInfo:
if let bestAttemptContent = bestAttemptContent { if let customData = bestAttemptContent.userInfo["custom"] as? [String: Any], let additionalData = customData["a"] as? [String: Any] { if let jsonData = try? JSONSerialization.data(withJSONObject: additionalData, options: .prettyPrinted), let jsonString = String(data: jsonData, encoding: .utf8) { print("The additionalData dictionary in JSON format:\n\(jsonString)") } else { print("Failed to convert additionalData to JSON format.") } } if let messageData = bestAttemptContent.userInfo["aps"] as? [String: Any], let apsData = messageData["alert"] as? [String: Any], let body = apsData["body"] as? String, let title = apsData["title"] as? String { print("The message contents is: \(body), message headings is: \(title)") } else { print("Unable to retrieve apsData") } OneSignalExtension.didReceiveNotificationExtensionRequest(self.receivedRequest, with: bestAttemptContent, withContentHandler: self.contentHandler)}
Exemplo de saída do console:
The additionalData dictionary in JSON format:{ "additional_data_key_1" : "value_1", "additional_data_key_2" : "value_2"}The message contents is: The message contents, message headings is: The message title
Selecione seu main app target > Build Phases > Embed App Extensions. Certifique-se de que “Copy only when installing” NÃO esteja marcado. Desmarque-o se estiver:
1. Atualizar o código OneSignalNotificationServiceExtension
Abra NotificationService.m ou NotificationService.swift e substitua todo o conteúdo do arquivo pelo código abaixo. Isso adiciona logs para ajudar a verificar se a extensão está sendo executada.Substitua YOUR_BUNDLE_ID pelo seu Bundle ID real.
Procure por OneSignalNotificationServiceExtension como a CATEGORY
Selecione Start
Envie para este dispositivo uma notificação com uma mensagem (use a propriedade contents se estiver enviando pela API Criar notificação). Neste exemplo, o payload é:
Por que minha extensão de serviço de notificação não está sendo executada no iOS?A extensão só é executada quando mutable-content está definido no payload da notificação. O OneSignal define isso automaticamente para notificações com anexos ou botões de ação. Verifique se as configurações do Xcode correspondem ao guia de solução de problemas.Posso impedir que uma notificação seja exibida no Android?Sim. Chame event.preventDefault() para suprimir a exibição. Em seguida, chame event.getNotification().display() para exibi-la mais tarde, ou nunca chame para descartá-la silenciosamente. Consulte Notificações duplicadas para mais informações.Preciso da anotação @Keep no Android?Sim. Ela evita que o ProGuard ou o R8 renomeie ou remova sua classe que implementa INotificationServiceExtension durante a minificação.