MessagingTopicManagementResponse interface
Stay organized with collections
Save and categorize content based on your preferences.
Interface representing the server response from the Messaging.subscribeToTopic() and Messaging.unsubscribeFromTopic() methods.
See Manage topics from the server for code samples and detailed documentation.
Signature:
export interface MessagingTopicManagementResponse
Properties
Property |
Type |
Description |
errors |
FirebaseArrayIndexError[] |
An array of errors corresponding to the provided registration token(s). The length of this array will be equal to MessagingTopicManagementResponse.failureCount. |
failureCount |
number |
The number of registration tokens that could not be subscribed to the topic and resulted in an error. |
successCount |
number |
The number of registration tokens that were successfully subscribed to the topic. |
MessagingTopicManagementResponse.errors
An array of errors corresponding to the provided registration token(s). The length of this array will be equal to MessagingTopicManagementResponse.failureCount.
Signature:
errors: FirebaseArrayIndexError[];
MessagingTopicManagementResponse.failureCount
The number of registration tokens that could not be subscribed to the topic and resulted in an error.
Signature:
failureCount: number;
MessagingTopicManagementResponse.successCount
The number of registration tokens that were successfully subscribed to the topic.
Signature:
successCount: number;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["# MessagingTopicManagementResponse interface\n\nInterface representing the server response from the [Messaging.subscribeToTopic()](./firebase-admin.messaging.messaging.md#messagingsubscribetotopic) and [Messaging.unsubscribeFromTopic()](./firebase-admin.messaging.messaging.md#messagingunsubscribefromtopic) methods.\n\nSee [Manage topics from the server](https://firebase.google.com/docs/cloud-messaging/manage-topics) for code samples and detailed documentation.\n\n**Signature:** \n\n export interface MessagingTopicManagementResponse \n\nProperties\n----------\n\n| Property | Type | Description |\n|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [errors](./firebase-admin.messaging.messagingtopicmanagementresponse.md#messagingtopicmanagementresponseerrors) | FirebaseArrayIndexError\\[\\] | An array of errors corresponding to the provided registration token(s). The length of this array will be equal to [MessagingTopicManagementResponse.failureCount](./firebase-admin.messaging.messagingtopicmanagementresponse.md#messagingtopicmanagementresponsefailurecount). |\n| [failureCount](./firebase-admin.messaging.messagingtopicmanagementresponse.md#messagingtopicmanagementresponsefailurecount) | number | The number of registration tokens that could not be subscribed to the topic and resulted in an error. |\n| [successCount](./firebase-admin.messaging.messagingtopicmanagementresponse.md#messagingtopicmanagementresponsesuccesscount) | number | The number of registration tokens that were successfully subscribed to the topic. |\n\nMessagingTopicManagementResponse.errors\n---------------------------------------\n\nAn array of errors corresponding to the provided registration token(s). The length of this array will be equal to [MessagingTopicManagementResponse.failureCount](./firebase-admin.messaging.messagingtopicmanagementresponse.md#messagingtopicmanagementresponsefailurecount).\n\n**Signature:** \n\n errors: FirebaseArrayIndexError[];\n\nMessagingTopicManagementResponse.failureCount\n---------------------------------------------\n\nThe number of registration tokens that could not be subscribed to the topic and resulted in an error.\n\n**Signature:** \n\n failureCount: number;\n\nMessagingTopicManagementResponse.successCount\n---------------------------------------------\n\nThe number of registration tokens that were successfully subscribed to the topic.\n\n**Signature:** \n\n successCount: number;"]]