Deprecate sendToDevice and sendToDeviceGroup and their response classes

1. Deprecate sendToDevice and its response class, MessagingDeviceResponse 2. Deprecate sendToDeviceGroup and its response class, MessagingDeviceGroupResponse
firebase · Mar 1, 2023 · a271310 · a271310
1 parent 49251a8
commit a271310
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/src/messaging/messaging-api.ts b/src/messaging/messaging-api.ts
@@ -940,7 +940,11 @@ export interface MessagingOptions {
   [key: string]: any | undefined;
 }
 
-/* Individual status response payload from single devices */
+/**
+ * Individual status response payload from single devices
+ *
+ * @deprecated Returned by {@link firebase-admin.messaging#sendToDevice} which is also deprecated.
+ */
 export interface MessagingDeviceResult {
   /**
    * The error that occurred when processing the message for the recipient.
@@ -967,6 +971,8 @@ export interface MessagingDeviceResult {
  * See
  * {@link https://firebase.google.com/docs/cloud-messaging/admin/send-messages#send_to_individual_devices |
  * Send to individual devices} for code samples and detailed documentation.
+ *
+ * @deprecated Returned by {@link firebase-admin.messaging#sendToDevice} which is also deprecated.
  */
 export interface MessagingDevicesResponse {
   canonicalRegistrationTokenCount: number;
@@ -983,6 +989,8 @@ export interface MessagingDevicesResponse {
  * See
  * {@link https://firebase.google.com/docs/cloud-messaging/send-message?authuser=0#send_messages_to_device_groups |
  * Send messages to device groups} for code samples and detailed documentation.
+ *
+ * @deprecated Returned by {@link firebase-admin.messaging#sendToDeviceGroup} which is also deprecated.
  */
 export interface MessagingDeviceGroupResponse {
 

diff --git a/src/messaging/messaging.ts b/src/messaging/messaging.ts
@@ -376,6 +376,8 @@ export class Messaging {
    *
    * @returns A promise fulfilled with the server's response after the message
    *   has been sent.
+   *
+   * @deprecated Use {@link firebase-admin.messaging#send} instead.
    */
   public sendToDevice(
     registrationTokenOrTokens: string | string[],
@@ -445,6 +447,8 @@ export class Messaging {
    *
    * @returns A promise fulfilled with the server's response after the message
    *   has been sent.
+   *
+   * @deprecated Use {@link firebase-admin.messaging#send} instead.
    */
   public sendToDeviceGroup(
     notificationKey: string,