app-metadata.d.ts 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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. /**
  18. * Platforms with which a Firebase App can be associated.
  19. */
  20. export declare enum AppPlatform {
  21. /**
  22. * Unknown state. This is only used for distinguishing unset values.
  23. */
  24. PLATFORM_UNKNOWN = "PLATFORM_UNKNOWN",
  25. /**
  26. * The Firebase App is associated with iOS.
  27. */
  28. IOS = "IOS",
  29. /**
  30. * The Firebase App is associated with Android.
  31. */
  32. ANDROID = "ANDROID"
  33. }
  34. /**
  35. * Metadata about a Firebase app.
  36. */
  37. export interface AppMetadata {
  38. /**
  39. * The globally unique, Firebase-assigned identifier of the app.
  40. *
  41. * @example
  42. * ```javascript
  43. * var appId = appMetadata.appId;
  44. * ```
  45. */
  46. appId: string;
  47. /**
  48. * The optional user-assigned display name of the app.
  49. *
  50. * @example
  51. * ```javascript
  52. * var displayName = appMetadata.displayName;
  53. * ```
  54. */
  55. displayName?: string;
  56. /**
  57. * The development platform of the app. Supporting Android and iOS app platforms.
  58. *
  59. * @example
  60. * ```javascript
  61. * var platform = AppPlatform.ANDROID;
  62. * ```
  63. */
  64. platform: AppPlatform;
  65. /**
  66. * The globally unique, user-assigned ID of the parent project for the app.
  67. *
  68. * @example
  69. * ```javascript
  70. * var projectId = appMetadata.projectId;
  71. * ```
  72. */
  73. projectId: string;
  74. /**
  75. * The fully-qualified resource name that identifies this app.
  76. *
  77. * This is useful when manually constructing requests for Firebase's public API.
  78. *
  79. * @example
  80. * ```javascript
  81. * var resourceName = androidAppMetadata.resourceName;
  82. * ```
  83. */
  84. resourceName: string;
  85. }