Skip to content

change(fcm): Deprecate sendToDevice and sendToDeviceGroup and their response classes #2090

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 2 commits into from
Mar 2, 2023
Merged

change(fcm): Deprecate sendToDevice and sendToDeviceGroup and their response classes #2090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16ba83a
Deprecate sendToDevice and sendToDeviceGroup and their response classes
Doris-Ge Feb 28, 2023
8cf57f6
Merge branch 'master' into remotes/dorisge/deprecate-legacy-send-apis
Doris-Ge Mar 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions etc/firebase-admin.messaging.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,9 @@ export class Messaging {
sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
// @deprecated
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
// @deprecated
sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
Expand All @@ -199,22 +201,22 @@ export interface MessagingConditionResponse {
messageId: number;
}

// @public
// @public @deprecated
export interface MessagingDeviceGroupResponse {
failedRegistrationTokens: string[];
failureCount: number;
successCount: number;
}

// @public (undocumented)
// @public @deprecated
export interface MessagingDeviceResult {
canonicalRegistrationToken?: string;
// Warning: (ae-forgotten-export) The symbol "FirebaseError" needs to be exported by the entry point index.d.ts
error?: FirebaseError;
messageId?: string;
}

// @public
// @public @deprecated
export interface MessagingDevicesResponse {
// (undocumented)
canonicalRegistrationTokenCount: number;
Expand Down
10 changes: 9 additions & 1 deletion src/messaging/messaging-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Messaging#sendToDevice}, which is also deprecated.
*/
export interface MessagingDeviceResult {
/**
* The error that occurred when processing the message for the recipient.
Expand All @@ -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 Messaging.sendToDevice}, which is also deprecated.
*/
export interface MessagingDevicesResponse {
canonicalRegistrationTokenCount: number;
Expand All @@ -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 Messaging.sendToDeviceGroup}, which is also deprecated.
*/
export interface MessagingDeviceGroupResponse {

Expand Down
4 changes: 4 additions & 0 deletions src/messaging/messaging.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Messaging.send} instead.
*/
public sendToDevice(
registrationTokenOrTokens: string | string[],
Expand Down Expand Up @@ -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 Messaging.send} instead.
*/
public sendToDeviceGroup(
notificationKey: string,
Expand Down