project-management-namespace.d.ts 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. /*! firebase-admin v12.1.1 */
  2. /*!
  3. * Copyright 2021 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 { App } from '../app';
  18. import { AppMetadata as TAppMetadata, AppPlatform as TAppPlatform } from './app-metadata';
  19. import { ProjectManagement as TProjectManagement } from './project-management';
  20. import { AndroidApp as TAndroidApp, AndroidAppMetadata as TAndroidAppMetadata, ShaCertificate as TShaCertificate } from './android-app';
  21. import { IosApp as TIosApp, IosAppMetadata as TIosAppMetadata } from './ios-app';
  22. /**
  23. * Gets the {@link firebase-admin.project-management#ProjectManagement} service for the
  24. * default app or a given app.
  25. *
  26. * `admin.projectManagement()` can be called with no arguments to access the
  27. * default app's `ProjectManagement` service, or as `admin.projectManagement(app)` to access
  28. * the `ProjectManagement` service associated with a specific app.
  29. *
  30. * @example
  31. * ```javascript
  32. * // Get the ProjectManagement service for the default app
  33. * var defaultProjectManagement = admin.projectManagement();
  34. * ```
  35. *
  36. * @example
  37. * ```javascript
  38. * // Get the ProjectManagement service for a given app
  39. * var otherProjectManagement = admin.projectManagement(otherApp);
  40. * ```
  41. *
  42. * @param app - Optional app whose `ProjectManagement` service
  43. * to return. If not provided, the default `ProjectManagement` service will
  44. * be returned. *
  45. * @returns The default `ProjectManagement` service if no app is provided or the
  46. * `ProjectManagement` service associated with the provided app.
  47. */
  48. export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
  49. export declare namespace projectManagement {
  50. /**
  51. * Type alias to {@link firebase-admin.project-management#AppMetadata}.
  52. */
  53. type AppMetadata = TAppMetadata;
  54. /**
  55. * Type alias to {@link firebase-admin.project-management#AppPlatform}.
  56. */
  57. type AppPlatform = TAppPlatform;
  58. /**
  59. * Type alias to {@link firebase-admin.project-management#ProjectManagement}.
  60. */
  61. type ProjectManagement = TProjectManagement;
  62. /**
  63. * Type alias to {@link firebase-admin.project-management#IosApp}.
  64. */
  65. type IosApp = TIosApp;
  66. /**
  67. * Type alias to {@link firebase-admin.project-management#IosAppMetadata}.
  68. */
  69. type IosAppMetadata = TIosAppMetadata;
  70. /**
  71. * Type alias to {@link firebase-admin.project-management#AndroidApp}.
  72. */
  73. type AndroidApp = TAndroidApp;
  74. /**
  75. * Type alias to {@link firebase-admin.project-management#AndroidAppMetadata}.
  76. */
  77. type AndroidAppMetadata = TAndroidAppMetadata;
  78. /**
  79. * Type alias to {@link firebase-admin.project-management#ShaCertificate}.
  80. */
  81. type ShaCertificate = TShaCertificate;
  82. }