Управление подписками на темы

Вы можете подписать клиентское приложение на тему как с сервера, так и с клиента:

  • На сервере с использованием Firebase Admin SDK .

  • На стороне клиента — с использованием клиентского API в вашем приложении.

Управление подписками на темы с помощью Admin SDK

Firebase Admin SDK позволяет выполнять базовые задачи управления темами на стороне сервера. Используя регистрационные токены, вы можете массово подписывать и отменять подписку на экземпляры клиентских приложений, используя серверную логику.

Вы можете подписать экземпляры клиентского приложения на любую существующую тему или создать новую. Когда вы используете API для подписки клиентского приложения на новую тему (которой ещё нет в вашем проекте Firebase), в FCM создаётся новая тема с этим именем, и любой клиент может впоследствии подписаться на неё.

Вы можете передать список токенов регистрации в метод подписки Firebase Admin SDK , чтобы подписать соответствующие устройства на тему:

Node.js 

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // ...
  'YOUR_REGISTRATION_TOKEN_n'
];

// Subscribe the devices corresponding to the registration tokens to the
// topic.
getMessaging().subscribeToTopic(registrationTokens, topic)
  .then((response) => {
    // See the MessagingTopicManagementResponse reference documentation
    // for the contents of response.
    console.log('Successfully subscribed to topic:', response);
  })
  .catch((error) => {
    console.log('Error subscribing to topic:', error);
  });

Ява 

// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

// Subscribe the devices corresponding to the registration tokens to the
// topic.
TopicManagementResponse response = FirebaseMessaging.getInstance().subscribeToTopic(
    registrationTokens, topic);
// See the TopicManagementResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " tokens were subscribed successfully");

Питон 

# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_n',
]

# Subscribe the devices corresponding to the registration tokens to the
# topic.
response = messaging.subscribe_to_topic(registration_tokens, topic)
# See the TopicManagementResponse reference documentation
# for the contents of response.
print(response.success_count, 'tokens were subscribed successfully')

Идти 

// These registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}

// Subscribe the devices corresponding to the registration tokens to the
// topic.
response, err := client.SubscribeToTopic(ctx, registrationTokens, topic)
if err != nil {
	log.Fatalln(err)
}
// See the TopicManagementResponse reference documentation
// for the contents of response.
fmt.Println(response.SuccessCount, "tokens were subscribed successfully")

С# 

// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};

// Subscribe the devices corresponding to the registration tokens to the
// topic
var response = await FirebaseMessaging.DefaultInstance.SubscribeToTopicAsync(
    registrationTokens, topic);
// See the TopicManagementResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} tokens were subscribed successfully");
FirebaseMessagingSnippets.cs

Firebase Admin SDK также позволяет отписывать устройства от темы, передавая токены регистрации соответствующему методу:

Node.js 

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // ...
  'YOUR_REGISTRATION_TOKEN_n'
];

// Unsubscribe the devices corresponding to the registration tokens from
// the topic.
getMessaging().unsubscribeFromTopic(registrationTokens, topic)
  .then((response) => {
    // See the MessagingTopicManagementResponse reference documentation
    // for the contents of response.
    console.log('Successfully unsubscribed from topic:', response);
  })
  .catch((error) => {
    console.log('Error unsubscribing from topic:', error);
  });

Ява 

// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

// Unsubscribe the devices corresponding to the registration tokens from
// the topic.
TopicManagementResponse response = FirebaseMessaging.getInstance().unsubscribeFromTopic(
    registrationTokens, topic);
// See the TopicManagementResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " tokens were unsubscribed successfully");

Питон 

# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_n',
]

# Unubscribe the devices corresponding to the registration tokens from the
# topic.
response = messaging.unsubscribe_from_topic(registration_tokens, topic)
# See the TopicManagementResponse reference documentation
# for the contents of response.
print(response.success_count, 'tokens were unsubscribed successfully')

Идти 

// These registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}

// Unsubscribe the devices corresponding to the registration tokens from
// the topic.
response, err := client.UnsubscribeFromTopic(ctx, registrationTokens, topic)
if err != nil {
	log.Fatalln(err)
}
// See the TopicManagementResponse reference documentation
// for the contents of response.
fmt.Println(response.SuccessCount, "tokens were unsubscribed successfully")

С# 

// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};

// Unsubscribe the devices corresponding to the registration tokens from the
// topic
var response = await FirebaseMessaging.DefaultInstance.UnsubscribeFromTopicAsync(
    registrationTokens, topic);
// See the TopicManagementResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} tokens were unsubscribed successfully");
FirebaseMessagingSnippets.cs

Методы subscribeToTopic() и unsubscribeFromTopic() возвращают объект, содержащий ответ от FCM . Возвращаемый тип имеет тот же формат, независимо от количества регистрационных токенов, указанных в запросе.

В случае ошибки (сбои аутентификации, недействительный токен или тема и т. д.) эти методы приводят к ошибке. Полный список кодов ошибок, включая описания и шаги по их устранению, см. в разделе «Ошибки Firebase Admin SDK .

Управляйте подписками на темы из вашего клиентского приложения

Экземпляры клиентского приложения также можно подписывать и отписываться от тем непосредственно из приложения через Firebase SDK. Обратите внимание, что FCM повторяет попытки в случае первоначальных сбоев, чтобы убедиться в успешности подписки.

Выберите свою платформу:

Андроид

Клиентские приложения могут подписываться на любую существующую тему или создавать новую. Когда клиентское приложение подписывается на новую тему (которой ещё нет в вашем проекте Firebase), в FCM создаётся новая тема с этим именем, и любой клиент может впоследствии подписаться на неё.

Чтобы подписаться на тему, клиентское приложение вызывает метод Firebase Cloud Messaging subscribeToTopic() с именем темы FCM . Этот метод возвращает Task , которую прослушиватель завершения может использовать для определения успешности подписки:

Kotlin 

Firebase.messaging.subscribeToTopic("weather")
    .addOnCompleteListener { task ->
        var msg = "Subscribed"
        if (!task.isSuccessful) {
            msg = "Subscribe failed"
        }
        Log.d(TAG, msg)
        Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show()
    }
MainActivity.kt

Java 

FirebaseMessaging.getInstance().subscribeToTopic("weather")
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                String msg = "Subscribed";
                if (!task.isSuccessful()) {
                    msg = "Subscribe failed";
                }
                Log.d(TAG, msg);
                Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show();
            }
        });
MainActivity.java

Чтобы отписаться, клиентское приложение вызывает Firebase Cloud Messaging unsubscribeFromTopic() указав имя темы.

iOS

Клиентские приложения могут подписываться на любую существующую тему или создавать новую. Когда клиентское приложение подписывается на новую тему (которой ещё нет в вашем проекте Firebase), в FCM создаётся новая тема с этим именем, и любой клиент может впоследствии подписаться на неё.

Чтобы подписаться на тему, вызовите метод подписки из основного потока приложения ( FCM не является потокобезопасным). Если запрос на подписку изначально не удалось выполнить, FCM автоматически повторяет попытку. В случаях, когда подписка не может быть завершена, она выдаёт ошибку, которую можно перехватить в обработчике завершения, как показано ниже:

Быстрый 

Messaging.messaging().subscribe(toTopic: "weather") { error in
  print("Subscribed to weather topic")
}
ViewController.swift

Objective-C 

[[FIRMessaging messaging] subscribeToTopic:@"weather"
                                completion:^(NSError * _Nullable error) {
  NSLog(@"Subscribed to weather topic");
}];
ViewController.m

Этот вызов выполняет асинхронный запрос к бэкенду FCM и подписывает клиента на заданную тему. Перед вызовом subscribeToTopic:topic убедитесь, что экземпляр клиентского приложения уже получил регистрационный токен через обратный вызов didReceiveRegistrationToken .

При каждом запуске приложения FCM проверяет, подписаны ли все запрошенные темы. Чтобы отписаться, вызовите unsubscribeFromTopic:topic , и FCM отпишется от темы в фоновом режиме.

С++

Чтобы подписаться на тему, вызовите метод ::firebase::messaging::Subscribe из своего приложения. Это позволит выполнить асинхронный запрос к бэкенду FCM и подписать клиента на заданную тему. 

::firebase::messaging::Subscribe("example");

Если запрос на подписку не удалось выполнить, FCM повторяет попытки, пока не подпишется на тему. При каждом запуске приложения FCM проверяет, что все запрошенные темы подписаны.

Чтобы отписаться, вызовите ::firebase::messaging::Unsubscribe , и FCM отпишется от темы в фоновом режиме.

Единство

Чтобы подписаться на тему, вызовите метод Firebase.Messaging.FirebaseMessaging.Subscribe из своего приложения. Это позволит выполнить асинхронный запрос к бэкенду FCM и подписать клиента на заданную тему. 

Firebase.Messaging.FirebaseMessaging.Subscribe("/topics/example");

Если запрос на подписку не удалось выполнить, FCM повторяет попытки, пока не подпишется на тему. При каждом запуске приложения FCM проверяет, что все запрошенные темы подписаны.

Чтобы отписаться, вызовите Firebase.Messaging.FirebaseMessaging.Unsubscribe , и FCM отпишется от темы в фоновом режиме.

Устаревшее серверное управление темами (устарело)

Чтобы узнать, что такое идентификаторы экземпляров, посетите страницу «Идентификаторы экземпляров» . Подробную информацию об устаревших конечных точках см. в справочниках по API идентификаторов экземпляров .