Включение push-уведомлений в Android

Push-уведомления позволяют клиентам получать уведомления о входящих сообщениях и других операциях, происходящих в потоке чата, когда мобильное приложение не работает на переднем плане. Службы коммуникации Azure поддерживают список событий, на которые можно подписываться.

Замечание

Push-уведомления чата поддерживаются для пакета SDK для Android в версиях начиная с версии 1.1.0-beta.4 и 1.1.0. Мы рекомендуем использовать версию 2.0.0 или более позднюю, так как в более ранних версиях возникла известная проблема с продлением регистрации. Шаги от 8 до 12 требуются только для версий, равных или больше 2.0.0.

1. Настройте Firebase Cloud Messaging для проекта ChatQuickstart. Выполните действия Create a Firebase project, Register your app with Firebaseи Add a Firebase configuration fileAdd Firebase SDKs to your appEdit your app manifest в документации Firebase.

2. Создайте центр уведомлений в той же подписке, что и ресурс служб коммуникации, настройте параметры Cloud Messaging Firebase для концентратора и свяжите концентратор уведомлений с ресурсом Служб коммуникации. См. статью о подготовке Центра уведомлений.

3. Создайте новый файл, который вызывается MyFirebaseMessagingService.java в том же каталоге, где MainActivity.java находится. Скопируйте следующий код в MyFirebaseMessagingService.java. Необходимо заменить <your_package_name> именем пакета, используемым в MainActivity.java. Вы можете использовать собственное значение для <your_intent_name>. Используйте это значение на шаге 6.

      package <your_package_name>;
   
      import android.content.Intent;
      import android.util.Log;
   
      import androidx.localbroadcastmanager.content.LocalBroadcastManager;
   
      import com.azure.android.communication.chat.models.ChatPushNotification;
      import com.google.firebase.messaging.FirebaseMessagingService;
      import com.google.firebase.messaging.RemoteMessage;
   
      import java.util.concurrent.Semaphore;
   
      public class MyFirebaseMessagingService extends FirebaseMessagingService {
          private static final String TAG = "MyFirebaseMsgService";
          public static Semaphore initCompleted = new Semaphore(1);
   
          @Override
          public void onMessageReceived(RemoteMessage remoteMessage) {
              try {
                  Log.d(TAG, "Incoming push notification.");
   
                  initCompleted.acquire();
   
                  if (remoteMessage.getData().size() > 0) {
                      ChatPushNotification chatPushNotification =
                          new ChatPushNotification().setPayload(remoteMessage.getData());
                      sendPushNotificationToActivity(chatPushNotification);
                  }
   
                  initCompleted.release();
              } catch (InterruptedException e) {
                  Log.e(TAG, "Error receiving push notification.");
              }
          }
   
          private void sendPushNotificationToActivity(ChatPushNotification chatPushNotification) {
              Log.d(TAG, "Passing push notification to Activity: " + chatPushNotification.getPayload());
              Intent intent = new Intent("<your_intent_name>");
              intent.putExtra("PushNotificationPayload", chatPushNotification);
              LocalBroadcastManager.getInstance(this).sendBroadcast(intent);
          }
      }
   
   

4. В верхней части файла MainActivity.javaдобавьте следующие инструкции импорта:

      import android.content.BroadcastReceiver;
      import android.content.Context;
      import android.content.Intent;
      import android.content.IntentFilter;
   
      import androidx.localbroadcastmanager.content.LocalBroadcastManager;
      import com.azure.android.communication.chat.models.ChatPushNotification;
      import com.google.android.gms.tasks.OnCompleteListener;
      import com.google.android.gms.tasks.Task;
      import com.google.firebase.messaging.FirebaseMessaging;
   

5. Добавьте в класс MainActivity следующий код.

      private BroadcastReceiver firebaseMessagingReceiver = new BroadcastReceiver() {
          @Override
          public void onReceive(Context context, Intent intent) {
              ChatPushNotification pushNotification =
                  (ChatPushNotification) intent.getParcelableExtra("PushNotificationPayload");
   
              Log.d(TAG, "Push Notification received in MainActivity: " + pushNotification.getPayload());
   
              boolean isHandled = chatAsyncClient.handlePushNotification(pushNotification);
              if (!isHandled) {
                  Log.d(TAG, "No listener registered for incoming push notification!");
              }
          }
      };
   
   
      private void startFcmPushNotification() {
          FirebaseMessaging.getInstance().getToken()
              .addOnCompleteListener(new OnCompleteListener<String>() {
                  @Override
                  public void onComplete(@NonNull Task<String> task) {
                      if (!task.isSuccessful()) {
                          Log.w(TAG, "Fetching FCM registration token failed", task.getException());
                          return;
                      }
   
                      // Get new FCM registration token
                      String token = task.getResult();
   
                      // Log and toast
                      Log.d(TAG, "Fcm push token generated:" + token);
                      Toast.makeText(MainActivity.this, token, Toast.LENGTH_SHORT).show();
   
                      chatAsyncClient.startPushNotifications(token, new Consumer<Throwable>() {
                          @Override
                          public void accept(Throwable throwable) {
                              Log.w(TAG, "Registration failed for push notifications!", throwable);
                          }
                      });
                  }
              });
      }
   
   

6. Обновите функцию onCreate в MainActivity.

      @Override
      protected void onCreate(Bundle savedInstanceState) {
          super.onCreate(savedInstanceState);
          setContentView(R.layout.activity_main);
   
          LocalBroadcastManager
              .getInstance(this)
              .registerReceiver(
                  firebaseMessagingReceiver,
                  new IntentFilter("<your_intent_name>"));
      }
   

7. Поместите следующий код после комментария <RECEIVE CHAT MESSAGES> в MainActivity:

   startFcmPushNotification();

   chatAsyncClient.addPushNotificationHandler(CHAT_MESSAGE_RECEIVED, (ChatEvent payload) -> {
       Log.i(TAG, "Push Notification CHAT_MESSAGE_RECEIVED.");
       ChatMessageReceivedEvent event = (ChatMessageReceivedEvent) payload;
       // You code to handle ChatMessageReceived event
   });

8. Добавьте поле xmlns:tools в файл AndroidManifest.xml.

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="com.azure.android.communication.chat.sampleapp">

9. Отключите инициализатор по умолчанию для WorkManager в AndroidManifest.xml.

    <!-- Disable the default initializer of WorkManager so that we could override it in MyAppConfiguration  -->
    <provider
        android:name="androidx.startup.InitializationProvider"
        android:authorities="${applicationId}.androidx-startup"
        android:exported="false"
        tools:node="merge">
      <!-- If you are using androidx.startup to initialize other components -->
      <meta-data
          android:name="androidx.work.WorkManagerInitializer"
          android:value="androidx.startup"
          tools:node="remove" />
    </provider>
    <!-- End of Disabling default initializer of WorkManager -->

10. Добавьте зависимость WorkManager в файл build.gradle.

    def work_version = "2.7.1"
    implementation "androidx.work:work-runtime:$work_version"

11. Добавьте пользовательский WorkManager инициализатор, создав класс, реализующий Configuration.Provider:

    public class MyAppConfiguration extends Application implements Configuration.Provider {
        Consumer<Throwable> exceptionHandler = new Consumer<Throwable>() {
            @Override
            public void accept(Throwable throwable) {
                Log.i("YOUR_TAG", "Registration failed for push notifications!" + throwable.getMessage());
            }
        };
    
        @Override
        public void onCreate() {
            super.onCreate();
            // Initialize application parameters here
            WorkManager.initialize(getApplicationContext(), getWorkManagerConfiguration());
        }
    
        @NonNull
        @Override
        public Configuration getWorkManagerConfiguration() {
            return new Configuration.Builder().
                setWorkerFactory(new RegistrationRenewalWorkerFactory(COMMUNICATION_TOKEN_CREDENTIAL, exceptionHandler)).build();
        }
    }

Описание предыдущего кода: Инициализатор WorkManager по умолчанию отключен на шаге 9. Этот шаг выполняет Configuration.Provider, чтобы предоставить настраиваемый объект WorkFactory, который отвечает за создание WorkerManager в процессе выполнения.

Если приложение интегрировано с функцией Azure, инициализируйте параметры приложения в методе onCreate(). Метод getWorkManagerConfiguration() вызывается при запуске приложения перед созданием любых действий, служб или объектов-получателей (за исключением поставщиков содержимого), поэтому параметры приложения можно инициализировать перед использованием. Дополнительные сведения см. в примере приложения чата.

12. android:name=.MyAppConfiguration Добавьте поле, в которое используется имя класса из шага 11, в AndroidManifest.xml:

<application
      android:allowBackup="true"
      android:icon="@mipmap/ic_launcher"
      android:label="@string/app_name"
      android:roundIcon="@mipmap/ic_launcher_round"
      android:theme="@style/Theme.AppCompat"
      android:supportsRtl="true"
      android:name=".MyAppConfiguration"
>

Связанные статьи

• Перенос push-уведомлений пакета SDK для Android в FCM версии 1
• Регистрация push-уведомлений пакета SDK для Android с помощью FCM версии 1