diff options
author | Ryan Wilson <wilsonryan@google.com> | 2018-06-28 13:48:13 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-06-28 13:48:13 -0400 |
commit | 2f6bf8d6695170fe15bb95d2eca6d6b7e56add74 (patch) | |
tree | a9b8f050c53de11d8a2f0fd16e5631987265c704 /Firebase/Core/Private/FIRComponentContainer.h | |
parent | 8d399c78bda9529832d6ecd70a6c4c564c62da6d (diff) |
Add FirebaseCore component interoperability. (#1437)
* Add FirebaseCore component interoperability.
This puts in place the system that will allow SDKs to register with
Core and retrieve functionalities provided by other SDKs.
* Updated documentation.
* Add copywrite, fix log messages.
* Explicitly import headers from Private dir
Diffstat (limited to 'Firebase/Core/Private/FIRComponentContainer.h')
-rw-r--r-- | Firebase/Core/Private/FIRComponentContainer.h | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/Firebase/Core/Private/FIRComponentContainer.h b/Firebase/Core/Private/FIRComponentContainer.h new file mode 100644 index 0000000..10e2255 --- /dev/null +++ b/Firebase/Core/Private/FIRComponentContainer.h @@ -0,0 +1,47 @@ +/* + * Copyright 2018 Google + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#import <Foundation/Foundation.h> + +#import "FIRComponentType.h" + +NS_ASSUME_NONNULL_BEGIN + +/// A type-safe macro to retrieve a component from a container. This should be used to retrieve +/// components instead of using the container directly. +#define FIR_COMPONENT(type, container) \ + [FIRComponentType<id<type>> instanceForProtocol:@protocol(type) inContainer:container] + +@class FIRApp; + +/// A container that holds different components that are registered via the +/// `registerAsComponentRegistrant:` call. These classes should conform to `FIRComponentRegistrant` +/// in order to properly register components for Core. +NS_SWIFT_NAME(FirebaseComponentContainer) +@interface FIRComponentContainer : NSObject + +/// A weak reference to the app that an instance of the container belongs to. +@property(nonatomic, weak, readonly) FIRApp *app; + +/// Unavailable. Use the `container` property on `FIRApp`. +- (instancetype)init NS_UNAVAILABLE; + +/// Register a class to provide components for the interoperability system. The class should conform +/// to `FIRComponentRegistrant` and provide an array of `FIRComponent` objects. ++ (void)registerAsComponentRegistrant:(Class)klass; + +@end + +NS_ASSUME_NONNULL_END |