index.d.ts 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  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. /**
  18. * Firebase project management.
  19. *
  20. * @packageDocumentation
  21. */
  22. import { App } from '../app';
  23. import { ProjectManagement } from './project-management';
  24. export { AppMetadata, AppPlatform } from './app-metadata';
  25. export { ProjectManagement } from './project-management';
  26. export { AndroidApp, AndroidAppMetadata, ShaCertificate } from './android-app';
  27. export { IosApp, IosAppMetadata } from './ios-app';
  28. /**
  29. * Gets the {@link ProjectManagement} service for the default app or a given app.
  30. *
  31. * `getProjectManagement()` can be called with no arguments to access the
  32. * default app's `ProjectManagement` service, or as `getProjectManagement(app)` to access
  33. * the `ProjectManagement` service associated with a specific app.
  34. *
  35. * @example
  36. * ```javascript
  37. * // Get the ProjectManagement service for the default app
  38. * const defaultProjectManagement = getProjectManagement();
  39. * ```
  40. *
  41. * @example
  42. * ```javascript
  43. * // Get the ProjectManagement service for a given app
  44. * const otherProjectManagement = getProjectManagement(otherApp);
  45. * ```
  46. *
  47. * @param app - Optional app whose `ProjectManagement` service
  48. * to return. If not provided, the default `ProjectManagement` service will
  49. * be returned. *
  50. * @returns The default `ProjectManagement` service if no app is provided or the
  51. * `ProjectManagement` service associated with the provided app.
  52. */
  53. export declare function getProjectManagement(app?: App): ProjectManagement;
  54. export { FirebaseProjectManagementError, ProjectManagementErrorCode } from '../utils/error';