messaging-internal.d.ts 1.2 KB

123456789101112131415161718192021222324252627
  1. /*! firebase-admin v12.1.1 */
  2. /*!
  3. * Copyright 2020 Google Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. import { Message } from './messaging-api';
  18. export declare const BLACKLISTED_DATA_PAYLOAD_KEYS: string[];
  19. export declare const BLACKLISTED_OPTIONS_KEYS: string[];
  20. /**
  21. * Checks if the given Message object is valid. Recursively validates all the child objects
  22. * included in the message (android, apns, data etc.). If successful, transforms the message
  23. * in place by renaming the keys to what's expected by the remote FCM service.
  24. *
  25. * @param {Message} Message An object to be validated.
  26. */
  27. export declare function validateMessage(message: Message): void;