com.azure.android.communication.chat.implementation.notifications.fcm

Class PushNotificationClient

java.lang.Object

com.azure.android.communication.chat.implementation.notifications.fcm.PushNotificationClient

public class PushNotificationClient
extends java.lang.Object

The registrar client interface

Constructor Summary

Constructors

Constructor and Description
PushNotificationClient(com.azure.android.communication.common.CommunicationTokenCredential communicationTokenCredential)

Method Summary

Modifier and Type	Method and Description
void	addPushNotificationHandler(ChatEventType chatEventType, java9.util.function.Consumer<ChatEvent> listener) Add handler for a chat event for push notifications.
boolean	handlePushNotification(ChatPushNotification pushNotification) Handle incoming push notification.
boolean	hasStarted() flag to indicate if push notification has started
void	removePushNotificationHandler(ChatEventType chatEventType, java9.util.function.Consumer<ChatEvent> listener) Remove handler from a chat event for push notifications.
void	startPushNotifications(java.lang.String deviceRegistrationToken, java9.util.function.Consumer<java.lang.Throwable> errorHandler) Register the current device for receiving incoming push notifications via FCM.
void	stopPushNotifications() Unregister the current device from receiving incoming push notifications.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PushNotificationClient

public PushNotificationClient(com.azure.android.communication.common.CommunicationTokenCredential communicationTokenCredential)

Method Detail

hasStarted

public boolean hasStarted()

flag to indicate if push notification has started

Returns:

boolean if push notification has started

startPushNotifications

public void startPushNotifications(java.lang.String deviceRegistrationToken,
                                   java9.util.function.Consumer<java.lang.Throwable> errorHandler)

Register the current device for receiving incoming push notifications via FCM.

Parameters:

deviceRegistrationToken - Device registration token obtained from the FCM SDK.

errorHandler - error handler callback for registration failures

Throws:

java.lang.RuntimeException - if push notifications failed to start.

stopPushNotifications

public void stopPushNotifications()

Unregister the current device from receiving incoming push notifications. All registered handlers will be removed.

handlePushNotification

public boolean handlePushNotification(ChatPushNotification pushNotification)

Handle incoming push notification. Invoke corresponding chat event handle if registered.

Parameters:

pushNotification - Incoming push notification payload from the FCM SDK.

Returns:

True if there's handler(s) for incoming push notification; otherwise, false.

addPushNotificationHandler

public void addPushNotificationHandler(ChatEventType chatEventType,
                                       java9.util.function.Consumer<ChatEvent> listener)

Add handler for a chat event for push notifications.

Parameters:

chatEventType - the chat event type

listener - the listener callback function

removePushNotificationHandler

public void removePushNotificationHandler(ChatEventType chatEventType,
                                          java9.util.function.Consumer<ChatEvent> listener)

Remove handler from a chat event for push notifications.

Parameters:

chatEventType - the chat event type

listener - the listener callback function