SendResponse interface
Stay organized with collections
Save and categorize content based on your preferences.
Interface representing the status of an individual message that was sent as part of a batch request.
Signature:
export interface SendResponse
Properties
Property |
Type |
Description |
error |
FirebaseError |
An error, if the message was not handed off to FCM successfully. |
messageId |
string |
A unique message ID string, if the message was handed off to FCM for delivery. |
success |
boolean |
A boolean indicating if the message was successfully handed off to FCM or not. When true, the messageId attribute is guaranteed to be set. When false, the error attribute is guaranteed to be set. |
SendResponse.error
An error, if the message was not handed off to FCM successfully.
Signature:
error?: FirebaseError;
SendResponse.messageId
A unique message ID string, if the message was handed off to FCM for delivery.
Signature:
messageId?: string;
SendResponse.success
A boolean indicating if the message was successfully handed off to FCM or not. When true, the messageId
attribute is guaranteed to be set. When false, the error
attribute is guaranteed to be set.
Signature:
success: boolean;
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,["Interface representing the status of an individual message that was sent as part of a batch request.\n\n**Signature:** \n\n export interface SendResponse \n\nProperties\n\nSendResponse.error\n\nAn error, if the message was not handed off to FCM successfully.\n\n**Signature:** \n\n error?: FirebaseError;\n\nSendResponse.messageId\n\nA unique message ID string, if the message was handed off to FCM for delivery.\n\n**Signature:** \n\n messageId?: string;\n\nSendResponse.success\n\nA boolean indicating if the message was successfully handed off to FCM or not. When true, the `messageId` attribute is guaranteed to be set. When false, the `error` attribute is guaranteed to be set.\n\n**Signature:** \n\n success: boolean;"]]