64 lines
2.7 KiB
TypeScript
64 lines
2.7 KiB
TypeScript
/*! firebase-admin v14.0.0 */
|
|
/*!
|
|
* Copyright 2026 Google LLC
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
import { ErrorInfo, FirebaseError } from '../utils/error';
|
|
/**
|
|
* The constant mapping for valid Messaging client error codes.
|
|
*/
|
|
export declare const MessagingErrorCode: {
|
|
readonly INVALID_ARGUMENT: "invalid-argument";
|
|
readonly INVALID_RECIPIENT: "invalid-recipient";
|
|
readonly INVALID_PAYLOAD: "invalid-payload";
|
|
readonly INVALID_DATA_PAYLOAD_KEY: "invalid-data-payload-key";
|
|
readonly PAYLOAD_SIZE_LIMIT_EXCEEDED: "payload-size-limit-exceeded";
|
|
readonly INVALID_OPTIONS: "invalid-options";
|
|
readonly INVALID_REGISTRATION_TOKEN: "invalid-registration-token";
|
|
readonly REGISTRATION_TOKEN_NOT_REGISTERED: "registration-token-not-registered";
|
|
readonly MISMATCHED_CREDENTIAL: "mismatched-credential";
|
|
readonly INVALID_PACKAGE_NAME: "invalid-package-name";
|
|
readonly DEVICE_MESSAGE_RATE_EXCEEDED: "device-message-rate-exceeded";
|
|
readonly TOPICS_MESSAGE_RATE_EXCEEDED: "topics-message-rate-exceeded";
|
|
readonly TOPICS_SUBSCRIPTION_RATE_EXCEEDED: "topics-subscription-rate-exceeded";
|
|
readonly MESSAGE_RATE_EXCEEDED: "message-rate-exceeded";
|
|
readonly THIRD_PARTY_AUTH_ERROR: "third-party-auth-error";
|
|
readonly TOO_MANY_TOPICS: "too-many-topics";
|
|
readonly AUTHENTICATION_ERROR: "authentication-error";
|
|
readonly SERVER_UNAVAILABLE: "server-unavailable";
|
|
readonly INTERNAL_ERROR: "internal-error";
|
|
readonly UNKNOWN_ERROR: "unknown-error";
|
|
};
|
|
/**
|
|
* The type definition for valid Messaging client error codes.
|
|
*/
|
|
export type MessagingErrorCode = typeof MessagingErrorCode[keyof typeof MessagingErrorCode];
|
|
/**
|
|
* Internal Messaging client error code mapping used to construct ErrorInfo.
|
|
*/
|
|
export declare const messagingClientErrorCode: {
|
|
readonly [K in keyof typeof MessagingErrorCode]: ErrorInfo;
|
|
};
|
|
/**
|
|
* Firebase Messaging error code structure. This extends `FirebaseError`.
|
|
*/
|
|
export declare class FirebaseMessagingError extends FirebaseError {
|
|
/**
|
|
*
|
|
* @param info - The error code info.
|
|
* @param message - The error message. This will override the default message if provided.
|
|
*/
|
|
constructor(info: ErrorInfo, message?: string);
|
|
}
|