FIRComponentContainer.h 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. /*
  2. * Copyright 2018 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. #import <FirebaseCore/FIRComponentType.h>
  18. #import <FirebaseCore/FIRLibrary.h>
  19. NS_ASSUME_NONNULL_BEGIN
  20. /// A type-safe macro to retrieve a component from a container. This should be used to retrieve
  21. /// components instead of using the container directly.
  22. #define FIR_COMPONENT(type, container) \
  23. [FIRComponentType<id<type>> instanceForProtocol:@protocol(type) inContainer:container]
  24. @class FIRApp;
  25. /// A container that holds different components that are registered via the
  26. /// `registerAsComponentRegistrant:` call. These classes should conform to `FIRComponentRegistrant`
  27. /// in order to properly register components for Core.
  28. NS_SWIFT_NAME(FirebaseComponentContainer)
  29. @interface FIRComponentContainer : NSObject
  30. /// A weak reference to the app that an instance of the container belongs to.
  31. @property(nonatomic, weak, readonly) FIRApp *app;
  32. /// Unavailable. Use the `container` property on `FIRApp`.
  33. - (instancetype)init NS_UNAVAILABLE;
  34. @end
  35. NS_ASSUME_NONNULL_END