adding pods method of package managing
This commit is contained in:
talksik
+21
@@ -0,0 +1,21 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 "FirebaseStorageUI/Sources/Public/FirebaseStorageUI/FIRStorageDownloadTask+SDWebImage.h"
|
||||
|
||||
@implementation FIRStorageDownloadTask (SDWebImage)
|
||||
|
||||
@end
|
||||
@@ -0,0 +1,19 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 "FirebaseStorageUI/Sources/Public/FirebaseStorageUI/FUIStorageDefine.h"
|
||||
|
||||
SDWebImageContextOption _Nonnull const SDWebImageContextFUIStorageMaxImageSize = @"FUIStorageMaxImageSize";
|
||||
@@ -0,0 +1,173 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 "FirebaseStorageUI/Sources/Public/FirebaseStorageUI/FUIStorageImageLoader.h"
|
||||
#import "FirebaseStorageUI/Sources/Public/FirebaseStorageUI/FIRStorageDownloadTask+SDWebImage.h"
|
||||
|
||||
#import <FirebaseCore/FirebaseCore.h>
|
||||
#import <FirebaseStorage/FirebaseStorage.h>
|
||||
|
||||
#if SWIFT_PACKAGE
|
||||
@import GTMSessionFetcherCore;
|
||||
#else
|
||||
#import <GTMSessionFetcher/GTMSessionFetcher.h>
|
||||
#endif // SWIFT_PACKAGE
|
||||
|
||||
@interface NSURL ()
|
||||
|
||||
@property (nonatomic, strong, readwrite, nullable) FIRStorageReference *sd_storageReference;
|
||||
|
||||
@end
|
||||
|
||||
@interface FIRStorageTask ()
|
||||
|
||||
@property(strong, atomic) GTMSessionFetcher *fetcher;
|
||||
|
||||
@end
|
||||
|
||||
@implementation FUIStorageImageLoader
|
||||
|
||||
+ (FUIStorageImageLoader *)sharedLoader {
|
||||
static dispatch_once_t onceToken;
|
||||
static FUIStorageImageLoader *loader;
|
||||
dispatch_once(&onceToken, ^{
|
||||
loader = [[FUIStorageImageLoader alloc] init];
|
||||
});
|
||||
return loader;
|
||||
}
|
||||
|
||||
- (instancetype)init {
|
||||
self = [super init];
|
||||
if (self) {
|
||||
_defaultMaxImageSize = 10e6;
|
||||
}
|
||||
return self;
|
||||
}
|
||||
|
||||
#pragma mark - SDImageLoader Protocol
|
||||
|
||||
- (BOOL)canRequestImageForURL:(NSURL *)url {
|
||||
if (!url) {
|
||||
return NO;
|
||||
}
|
||||
if ([url.scheme isEqualToString:@"gs"]) {
|
||||
return YES;
|
||||
}
|
||||
return url.sd_storageReference != nil;
|
||||
}
|
||||
|
||||
- (id<SDWebImageOperation>)requestImageWithURL:(NSURL *)url options:(SDWebImageOptions)options context:(SDWebImageContext *)context progress:(SDImageLoaderProgressBlock)progressBlock completed:(SDImageLoaderCompletedBlock)completedBlock {
|
||||
FIRStorageReference *storageRef = url.sd_storageReference;
|
||||
if (!storageRef) {
|
||||
// Create Storage Reference from URL
|
||||
NSString *bucketUrl = [NSString stringWithFormat:@"gs://%@", url.host];
|
||||
FIRStorage *storage = [FIRStorage storageWithURL:bucketUrl];
|
||||
storageRef = [storage referenceWithPath:url.path];
|
||||
url.sd_storageReference = storageRef;
|
||||
}
|
||||
|
||||
if (!storageRef) {
|
||||
if (completedBlock) {
|
||||
NSError *error = [NSError errorWithDomain:SDWebImageErrorDomain code:SDWebImageErrorInvalidURL userInfo:@{NSLocalizedDescriptionKey : @"The provided image url must have an associated FIRStorageReference."}];
|
||||
completedBlock(nil, nil, error, YES);
|
||||
}
|
||||
}
|
||||
|
||||
UInt64 size;
|
||||
if (context[SDWebImageContextFUIStorageMaxImageSize]) {
|
||||
size = [context[SDWebImageContextFUIStorageMaxImageSize] unsignedLongLongValue];
|
||||
} else {
|
||||
size = self.defaultMaxImageSize;
|
||||
}
|
||||
// Download the image from Firebase Storage
|
||||
// Each download task use independent serial coder queue, to ensure callback in order during prorgessive decoding
|
||||
NSOperationQueue *coderQueue = [NSOperationQueue new];
|
||||
coderQueue.maxConcurrentOperationCount = 1;
|
||||
FIRStorageDownloadTask * download = [storageRef dataWithMaxSize:size completion:^(NSData * _Nullable data, NSError * _Nullable error) {
|
||||
if (error) {
|
||||
dispatch_main_async_safe(^{
|
||||
if (completedBlock) {
|
||||
completedBlock(nil, nil, error, YES);
|
||||
}
|
||||
});
|
||||
return;
|
||||
}
|
||||
// Decode the image with data
|
||||
[coderQueue cancelAllOperations];
|
||||
[coderQueue addOperationWithBlock:^{
|
||||
UIImage *image = SDImageLoaderDecodeImageData(data, url, options, context);
|
||||
dispatch_main_async_safe(^{
|
||||
if (completedBlock) {
|
||||
completedBlock(image, data, nil, YES);
|
||||
}
|
||||
});
|
||||
}];
|
||||
}];
|
||||
// Observe the progress changes
|
||||
[download observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot * _Nonnull snapshot) {
|
||||
// Check progressive decoding if need
|
||||
if (options & SDWebImageProgressiveLoad) {
|
||||
FIRStorageDownloadTask *task = snapshot.task;
|
||||
// Currently, FIRStorageDownloadTask does not have the API to grab partial data
|
||||
// But since FirebaseUI and Firebase are seamless component, we access the internal fetcher here
|
||||
GTMSessionFetcher *fetcher = task.fetcher;
|
||||
// Get the partial image data
|
||||
NSData *partialData = [fetcher.downloadedData copy];
|
||||
// Get response
|
||||
int64_t expectedSize = fetcher.response.expectedContentLength;
|
||||
expectedSize = expectedSize > 0 ? expectedSize : 0;
|
||||
int64_t receivedSize = fetcher.downloadedLength;
|
||||
if (expectedSize != 0) {
|
||||
// Get the finish status
|
||||
BOOL finished = receivedSize >= expectedSize;
|
||||
// This progress block may be called on main queue or global queue (depends configuration), always dispatched on coder queue
|
||||
if (coderQueue.operationCount == 0) {
|
||||
[coderQueue addOperationWithBlock:^{
|
||||
UIImage *image = SDImageLoaderDecodeProgressiveImageData(partialData, url, finished, task, options, context);
|
||||
if (image) {
|
||||
dispatch_main_async_safe(^{
|
||||
if (completedBlock) {
|
||||
completedBlock(image, partialData, nil, NO);
|
||||
}
|
||||
});
|
||||
}
|
||||
}];
|
||||
}
|
||||
}
|
||||
}
|
||||
NSProgress *progress = snapshot.progress;
|
||||
if (progressBlock) {
|
||||
progressBlock((NSInteger)progress.completedUnitCount,
|
||||
(NSInteger)progress.totalUnitCount,
|
||||
url);
|
||||
}
|
||||
}];
|
||||
|
||||
return download;
|
||||
}
|
||||
|
||||
- (BOOL)shouldBlockFailedURLWithURL:(NSURL *)url error:(NSError *)error {
|
||||
if ([error.domain isEqualToString:FIRStorageErrorDomain]) {
|
||||
if (error.code == FIRStorageErrorCodeBucketNotFound
|
||||
|| error.code == FIRStorageErrorCodeProjectNotFound
|
||||
|| error.code == FIRStorageErrorCodeObjectNotFound) {
|
||||
return YES;
|
||||
}
|
||||
}
|
||||
return NO;
|
||||
}
|
||||
|
||||
@end
|
||||
@@ -0,0 +1,49 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 "FirebaseStorageUI/Sources/Public/FirebaseStorageUI/NSURL+FirebaseStorage.h"
|
||||
#import <objc/runtime.h>
|
||||
|
||||
@implementation NSURL (FirebaseStorage)
|
||||
|
||||
- (FIRStorageReference *)sd_storageReference {
|
||||
return objc_getAssociatedObject(self, @selector(sd_storageReference));
|
||||
}
|
||||
|
||||
- (void)setSd_storageReference:(FIRStorageReference * _Nullable)sd_storageReference {
|
||||
objc_setAssociatedObject(self, @selector(sd_storageReference), sd_storageReference, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
|
||||
}
|
||||
|
||||
+ (instancetype)sd_URLWithStorageReference:(FIRStorageReference *)storageRef {
|
||||
if (!storageRef.bucket || !storageRef.fullPath) {
|
||||
return nil;
|
||||
}
|
||||
// gs://bucket/path/to/object.txt
|
||||
NSURLComponents *components = [[NSURLComponents alloc] initWithString:[NSString stringWithFormat:@"%@://%@/", @"gs", storageRef.bucket]];
|
||||
NSString *encodedPath = [storageRef.fullPath stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLPathAllowedCharacterSet]];
|
||||
components.path = [components.path stringByAppendingString:encodedPath];
|
||||
|
||||
NSURL *url = components.URL;
|
||||
if (!url) {
|
||||
return nil;
|
||||
}
|
||||
|
||||
url.sd_storageReference = storageRef;
|
||||
|
||||
return url;
|
||||
}
|
||||
|
||||
@end
|
||||
+27
@@ -0,0 +1,27 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 <FirebaseStorage/FirebaseStorage.h>
|
||||
#import <SDWebImage/SDWebImage.h>
|
||||
|
||||
NS_ASSUME_NONNULL_BEGIN
|
||||
|
||||
// `FIRStorageDownloadTask` conforms to `SDWebImageOperation` protocol
|
||||
@interface FIRStorageDownloadTask (SDWebImage) <SDWebImageOperation>
|
||||
|
||||
@end
|
||||
|
||||
NS_ASSUME_NONNULL_END
|
||||
Generated
+24
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 <FirebaseStorage/FirebaseStorage.h>
|
||||
#import <SDWebImage/SDWebImage.h>
|
||||
|
||||
/**
|
||||
* A UInt64 raw value specify the maximum size of the downloaded image. If the downloaded image
|
||||
* exceeds this size, an error will be raised in the completion block. (NSNumber *)
|
||||
*/
|
||||
FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextFUIStorageMaxImageSize;
|
||||
Generated
+54
@@ -0,0 +1,54 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 <SDWebImage/SDWebImage.h>
|
||||
#import "FUIStorageDefine.h"
|
||||
#import "NSURL+FirebaseStorage.h"
|
||||
|
||||
NS_ASSUME_NONNULL_BEGIN
|
||||
|
||||
/*
|
||||
* This Firebase Storage loader is used to load a `Firebase Storage reference` of image record.
|
||||
* To use the Firebase Storage loader, you can use the API in `UIImageView+FirebaseStorage.h` for simple usage.
|
||||
* You can also use the native SDWebImage's View Category API, with the URL constructed with `FIRStorageReference`. See `NSURL+FirebaseStorage.h`
|
||||
* @code
|
||||
// Supports HTTP URL as well as Firebase Storage URL globally. Put this in the early setup step like AppDelegate.m
|
||||
SDImageLoadersManager.loaders = @[SDWebImageDownloader.sharedDownloader, FUIStorageImageLoader.sharedLoader];
|
||||
// Replace default manager's loader implementation
|
||||
SDWebImageManager.defaultImageLoader = SDImageLoadersManager.sharedManager;
|
||||
|
||||
// Then you can simply call SDWebImage's APIs the same as normal HTTP URL
|
||||
FIRStorageReference *storageRef;
|
||||
NSURL *url = [NSURL sd_URLWithStorageReference:storageRef];
|
||||
[imageView sd_setImageWithURL:url];
|
||||
* @endcode
|
||||
*/
|
||||
NS_SWIFT_NAME(StorageImageLoader)
|
||||
@interface FUIStorageImageLoader : NSObject<SDImageLoader>
|
||||
|
||||
/**
|
||||
* The maximum image download size, in bytes. Defaults to 10e6.
|
||||
*/
|
||||
@property (nonatomic, assign) UInt64 defaultMaxImageSize;
|
||||
|
||||
/**
|
||||
The global shared instance for Firebase Storage loader.
|
||||
*/
|
||||
@property (nonatomic, class, readonly, nonnull) FUIStorageImageLoader *sharedLoader;
|
||||
|
||||
@end
|
||||
|
||||
NS_ASSUME_NONNULL_END
|
||||
Generated
+30
@@ -0,0 +1,30 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 <UIKit/UIKit.h>
|
||||
|
||||
//! Project version number for FirebaseStorageUI.
|
||||
FOUNDATION_EXPORT double FirebaseStorageUIVersionNumber;
|
||||
|
||||
//! Project version string for FirebaseStorageUI.
|
||||
FOUNDATION_EXPORT const unsigned char FirebaseStorageUIVersionString[];
|
||||
|
||||
#import "UIImageView+FirebaseStorage.h"
|
||||
#import "FUIStorageImageLoader.h"
|
||||
#import "FUIStorageDefine.h"
|
||||
#import "NSURL+FirebaseStorage.h"
|
||||
#import "FIRStorageDownloadTask+SDWebImage.h"
|
||||
Generated
+38
@@ -0,0 +1,38 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 <FirebaseStorage/FirebaseStorage.h>
|
||||
|
||||
NS_ASSUME_NONNULL_BEGIN
|
||||
|
||||
@interface NSURL (FirebaseStorage)
|
||||
|
||||
/**
|
||||
The `FIRStorageReference` value for Firebase Storage reference, or nil for other URL.
|
||||
*/
|
||||
@property (nonatomic, strong, readonly, nullable) FIRStorageReference *sd_storageReference;
|
||||
|
||||
/**
|
||||
Create a Firebase Storage reference URL with `FIRStorageReference`
|
||||
|
||||
@param storageRef `FIRStorageReference` object
|
||||
@return A Firebase Storage reference URL
|
||||
*/
|
||||
+ (nullable instancetype)sd_URLWithStorageReference:(nonnull FIRStorageReference *)storageRef;
|
||||
|
||||
@end
|
||||
|
||||
NS_ASSUME_NONNULL_END
|
||||
+179
@@ -0,0 +1,179 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 <UIKit/UIKit.h>
|
||||
|
||||
#import <FirebaseStorage/FirebaseStorage.h>
|
||||
#import <SDWebImage/SDWebImage.h>
|
||||
|
||||
NS_ASSUME_NONNULL_BEGIN
|
||||
|
||||
|
||||
/**
|
||||
* Integrates SDWebImage async image loading and Firebase Storage with UIImageView.
|
||||
*
|
||||
* @code
|
||||
// Reference to an image file in Firebase Storage
|
||||
FIRStorageReference *reference = [storageRef child:@"images/stars.jpg"];
|
||||
|
||||
// UIImageView in your ViewController
|
||||
UIImageView *imageView = self.imageView;
|
||||
|
||||
// Placeholder image
|
||||
UIImage *placeholderImage;
|
||||
|
||||
// Load the image using SDWebImage
|
||||
[imageView sd_setImageWithStorageReference:reference placeholderImage:placeholderImage];
|
||||
* @endcode
|
||||
*/
|
||||
@interface UIImageView (FirebaseStorage)
|
||||
|
||||
/**
|
||||
* The current download task, if the image view is downloading an image.
|
||||
*/
|
||||
@property (nonatomic, readonly, nullable) FIRStorageDownloadTask *sd_currentDownloadTask;
|
||||
|
||||
/**
|
||||
* Sets the image view's image to an image downloaded from the Firebase Storage reference.
|
||||
* Must be invoked on the main queue.
|
||||
*
|
||||
* @param storageRef A Firebase Storage reference containing an image.
|
||||
*/
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef;
|
||||
|
||||
/**
|
||||
* Sets the image view's image to an image downloaded from the Firebase Storage reference.
|
||||
* Must be invoked on the main queue.
|
||||
*
|
||||
* @param storageRef A Firebase Storage reference containing an image.
|
||||
* @param placeholder An image to display while the download is in progress.
|
||||
*/
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
placeholderImage:(nullable UIImage *)placeholder;
|
||||
|
||||
/**
|
||||
* Sets the image view's image to an image downloaded from the Firebase Storage reference.
|
||||
* Must be invoked on the main queue.
|
||||
*
|
||||
* @param storageRef A Firebase Storage reference containing an image.
|
||||
* @param placeholder An image to display while the download is in progress.
|
||||
* @param completionBlock A closure to handle events when the image finishes downloading.
|
||||
* The closure is guaranteed to be invoked on the main queue.
|
||||
*/
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
placeholderImage:(nullable UIImage *)placeholder
|
||||
completion:(void (^_Nullable)(UIImage *_Nullable,
|
||||
NSError *_Nullable,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock;
|
||||
|
||||
/**
|
||||
* Sets the image view's image to an image downloaded from the Firebase Storage reference.
|
||||
* Must be invoked on the main queue.
|
||||
*
|
||||
* @param storageRef A Firebase Storage reference containing an image.
|
||||
* @param size The maximum size of the downloaded image. If the downloaded image
|
||||
* exceeds this size, an error will be raised in the completion block.
|
||||
* @param placeholder An image to display while the download is in progress.
|
||||
* @param completionBlock A closure to handle events when the image finishes downloading.
|
||||
* The closure is guaranteed to be invoked on the main queue.
|
||||
*/
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
maxImageSize:(UInt64)size
|
||||
placeholderImage:(nullable UIImage *)placeholder
|
||||
completion:(void (^_Nullable)(UIImage *_Nullable,
|
||||
NSError *_Nullable,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock;
|
||||
|
||||
/**
|
||||
* Sets the image view's image to an image downloaded from the Firebase Storage reference.
|
||||
* Must be invoked on the main queue.
|
||||
*
|
||||
* @param storageRef A Firebase Storage reference containing an image.
|
||||
* @param size The maximum size of the downloaded image. If the downloaded image
|
||||
* exceeds this size, an error will be raised in the completion block.
|
||||
* @param placeholder An image to display while the download is in progress.
|
||||
* @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
|
||||
* @param completionBlock A closure to handle events when the image finishes downloading.
|
||||
* The closure is guaranteed to be invoked on the main queue.
|
||||
*/
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
maxImageSize:(UInt64)size
|
||||
placeholderImage:(nullable UIImage *)placeholder
|
||||
options:(SDWebImageOptions)options
|
||||
completion:(void (^_Nullable)(UIImage *_Nullable,
|
||||
NSError *_Nullable,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock;
|
||||
|
||||
/**
|
||||
* Sets the image view's image to an image downloaded from the Firebase Storage reference.
|
||||
* Must be invoked on the main queue.
|
||||
*
|
||||
* @param storageRef A Firebase Storage reference containing an image.
|
||||
* @param size The maximum size of the downloaded image. If the downloaded image
|
||||
* exceeds this size, an error will be raised in the completion block.
|
||||
* @param placeholder An image to display while the download is in progress.
|
||||
* @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
|
||||
* @param progressBlock A closure to handle the progress change during the image downloading. The closure args are `receivedSize` `expectedSize` and `storageRef`
|
||||
* The progress block is executed on a background queue.
|
||||
* @param completionBlock A closure to handle events when the image finishes downloading.
|
||||
* The closure is guaranteed to be invoked on the main queue.
|
||||
*/
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
maxImageSize:(UInt64)size
|
||||
placeholderImage:(nullable UIImage *)placeholder
|
||||
options:(SDWebImageOptions)options
|
||||
progress:(void (^_Nullable)(NSInteger,
|
||||
NSInteger,
|
||||
FIRStorageReference *))progressBlock
|
||||
completion:(void (^_Nullable)(UIImage *_Nullable,
|
||||
NSError *_Nullable,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock;
|
||||
|
||||
/**
|
||||
* Sets the image view's image to an image downloaded from the Firebase Storage reference.
|
||||
* Must be invoked on the main queue.
|
||||
*
|
||||
* @param storageRef A Firebase Storage reference containing an image.
|
||||
* @param size The maximum size of the downloaded image. If the downloaded image
|
||||
* exceeds this size, an error will be raised in the completion block.
|
||||
* @param placeholder An image to display while the download is in progress.
|
||||
* @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
|
||||
* @param context A context contains different options to perform specify changes or processes, see `SDWebImageContextOption`. This hold the extra objects which `options` enum can not hold. For example, you can use [.customManager] to use a custom manager with the desired cache instance for this image request.
|
||||
* @param progressBlock A closure to handle the progress change during the image downloading. The closure args are `receivedSize` `expectedSize` and `storageRef`
|
||||
* The progress block is executed on a background queue.
|
||||
* @param completionBlock A closure to handle events when the image finishes downloading.
|
||||
* The closure is guaranteed to be invoked on the main queue.
|
||||
*/
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
maxImageSize:(UInt64)size
|
||||
placeholderImage:(nullable UIImage *)placeholder
|
||||
options:(SDWebImageOptions)options
|
||||
context:(nullable SDWebImageContext *)context
|
||||
progress:(void (^_Nullable)(NSInteger,
|
||||
NSInteger,
|
||||
FIRStorageReference *))progressBlock
|
||||
completion:(void (^_Nullable)(UIImage *_Nullable,
|
||||
NSError *_Nullable,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock;
|
||||
|
||||
@end
|
||||
|
||||
NS_ASSUME_NONNULL_END
|
||||
+143
@@ -0,0 +1,143 @@
|
||||
//
|
||||
// Copyright (c) 2019 Google Inc.
|
||||
//
|
||||
// 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 "FirebaseStorageUI/Sources/Public/FirebaseStorageUI/UIImageView+FirebaseStorage.h"
|
||||
#import "FirebaseStorageUI/Sources/Public/FirebaseStorageUI/FUIStorageImageLoader.h"
|
||||
|
||||
@implementation UIImageView (FirebaseStorage)
|
||||
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef {
|
||||
[self sd_setImageWithStorageReference:storageRef placeholderImage:nil completion:nil];
|
||||
}
|
||||
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
placeholderImage:(UIImage *)placeholder {
|
||||
[self sd_setImageWithStorageReference:storageRef placeholderImage:placeholder completion:nil];
|
||||
}
|
||||
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
placeholderImage:(UIImage *)placeholder
|
||||
completion:(void (^)(UIImage *_Nullable,
|
||||
NSError *_Nullable,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock {
|
||||
[self sd_setImageWithStorageReference:storageRef
|
||||
maxImageSize:FUIStorageImageLoader.sharedLoader.defaultMaxImageSize
|
||||
placeholderImage:placeholder
|
||||
completion:completionBlock];
|
||||
}
|
||||
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
maxImageSize:(UInt64)size
|
||||
placeholderImage:(nullable UIImage *)placeholder
|
||||
completion:(void (^)(UIImage *,
|
||||
NSError *,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock{
|
||||
[self sd_setImageWithStorageReference:storageRef
|
||||
maxImageSize:size
|
||||
placeholderImage:placeholder
|
||||
options:0
|
||||
completion:completionBlock];
|
||||
}
|
||||
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
maxImageSize:(UInt64)size
|
||||
placeholderImage:(nullable UIImage *)placeholder
|
||||
options:(SDWebImageOptions)options
|
||||
completion:(void (^)(UIImage *,
|
||||
NSError *,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock {
|
||||
[self sd_setImageWithStorageReference:storageRef
|
||||
maxImageSize:size
|
||||
placeholderImage:placeholder
|
||||
options:options
|
||||
progress:nil
|
||||
completion:completionBlock];
|
||||
}
|
||||
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
maxImageSize:(UInt64)size
|
||||
placeholderImage:(nullable UIImage *)placeholder
|
||||
options:(SDWebImageOptions)options
|
||||
progress:(void (^)(NSInteger,
|
||||
NSInteger,
|
||||
FIRStorageReference *))progressBlock
|
||||
completion:(void (^)(UIImage *,
|
||||
NSError *,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock {
|
||||
[self sd_setImageWithStorageReference:storageRef
|
||||
maxImageSize:size
|
||||
placeholderImage:placeholder
|
||||
options:options
|
||||
context:nil
|
||||
progress:progressBlock
|
||||
completion:completionBlock];
|
||||
}
|
||||
|
||||
- (void)sd_setImageWithStorageReference:(FIRStorageReference *)storageRef
|
||||
maxImageSize:(UInt64)size
|
||||
placeholderImage:(nullable UIImage *)placeholder
|
||||
options:(SDWebImageOptions)options
|
||||
context:(nullable SDWebImageContext *)context
|
||||
progress:(void (^)(NSInteger,
|
||||
NSInteger,
|
||||
FIRStorageReference *))progressBlock
|
||||
completion:(void (^)(UIImage *,
|
||||
NSError *,
|
||||
SDImageCacheType,
|
||||
FIRStorageReference *))completionBlock {
|
||||
NSParameterAssert(storageRef != nil);
|
||||
|
||||
NSURL *url = [NSURL sd_URLWithStorageReference:storageRef];
|
||||
|
||||
SDWebImageMutableContext *mutableContext;
|
||||
if (context) {
|
||||
mutableContext = [context mutableCopy];
|
||||
} else {
|
||||
mutableContext = [NSMutableDictionary dictionary];
|
||||
}
|
||||
mutableContext[SDWebImageContextImageLoader] = FUIStorageImageLoader.sharedLoader;
|
||||
mutableContext[SDWebImageContextFUIStorageMaxImageSize] = @(size);
|
||||
|
||||
[self sd_setImageWithURL:url placeholderImage:placeholder options:options context:[mutableContext copy] progress:^(NSInteger receivedSize, NSInteger expectedSize, NSURL * _Nullable targetURL) {
|
||||
if (progressBlock) {
|
||||
progressBlock(receivedSize, expectedSize, storageRef);
|
||||
}
|
||||
} completed:^(UIImage * _Nullable image, NSError * _Nullable error, SDImageCacheType cacheType, NSURL * _Nullable imageURL) {
|
||||
if (completionBlock) {
|
||||
completionBlock(image, error, cacheType, storageRef);
|
||||
}
|
||||
}];
|
||||
}
|
||||
|
||||
#pragma mark - Accessors
|
||||
|
||||
- (FIRStorageDownloadTask *)sd_currentDownloadTask {
|
||||
SDWebImageCombinedOperation *operation = [self sd_imageLoadOperationForKey:NSStringFromClass(self.class)];
|
||||
if (operation) {
|
||||
id<SDWebImageOperation> loaderOperation = operation.loaderOperation;
|
||||
// This is a protocol, check the class
|
||||
if ([loaderOperation isKindOfClass:[FIRStorageDownloadTask class]]) {
|
||||
return (FIRStorageDownloadTask *)loaderOperation;
|
||||
}
|
||||
}
|
||||
return nil;
|
||||
}
|
||||
|
||||
@end
|
||||
Generated
+202
@@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
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.
|
||||
Generated
+156
@@ -0,0 +1,156 @@
|
||||
# FirebaseUI for iOS — UI Bindings for Firebase
|
||||
|
||||
          
|
||||
|
||||
FirebaseUI is an open-source library for iOS that allows you to quickly connect common UI elements to the [Firebase](https://firebase.google.com?utm_source=FirebaseUI-iOS) database for data storage, allowing views to be updated in realtime as they change, and providing simple interfaces for common tasks like displaying lists or collections of items.
|
||||
|
||||
Additionally, FirebaseUI simplifies Firebase authentication by providing easy to use auth methods that integrate with common identity providers like Facebook, Twitter, and Google as well as allowing developers to use a built in headful UI for ease of development.
|
||||
|
||||
FirebaseUI clients are also available for [Android](https://github.com/firebase/FirebaseUI-Android) and [web](https://github.com/firebase/firebaseui-web).
|
||||
|
||||
|
||||
|
||||
## Installing FirebaseUI for iOS
|
||||
|
||||
FirebaseUI supports iOS 10.0+ and Xcode 11+. We recommend using [CocoaPods](https://cocoapods.org/pods/FirebaseUI), add
|
||||
the following to your `Podfile`:
|
||||
|
||||
```ruby
|
||||
pod 'FirebaseUI', '~> 8.0' # Pull in all Firebase UI features
|
||||
```
|
||||
|
||||
If you don't want to use all of FirebaseUI, there are multiple subspecs which can selectively install subsets of the full feature set:
|
||||
|
||||
```ruby
|
||||
# Only pull in Firestore features
|
||||
pod 'FirebaseUI/Firestore', '~> 8.0'
|
||||
|
||||
# Only pull in Database features
|
||||
pod 'FirebaseUI/Database', '~> 8.0'
|
||||
|
||||
# Only pull in Storage features
|
||||
pod 'FirebaseUI/Storage', '~> 8.0'
|
||||
|
||||
# Only pull in Auth features
|
||||
pod 'FirebaseUI/Auth', '~> 8.0'
|
||||
|
||||
# Only pull in Facebook login features
|
||||
pod 'FirebaseUI/Facebook', '~> 8.0'
|
||||
|
||||
# Only pull in Google login features
|
||||
pod 'FirebaseUI/Google', '~> 8.0'
|
||||
|
||||
# Only pull in Phone Auth login features
|
||||
pod 'FirebaseUI/Phone', '~> 8.0'
|
||||
```
|
||||
|
||||
If you're including FirebaseUI in a Swift project, make sure you also have:
|
||||
|
||||
```ruby
|
||||
platform :ios, '10.0'
|
||||
use_frameworks!
|
||||
```
|
||||
|
||||
Otherwise, you can include the FirebaseUI Xcode project from this repo in
|
||||
your project. You also need to
|
||||
[add the Firebase framework](https://firebase.google.com/docs/ios/setup)
|
||||
to your project.
|
||||
|
||||
## Documentation
|
||||
|
||||
The READMEs for components of FirebaseUI can be found in their respective
|
||||
project folders.
|
||||
|
||||
- [Auth](Auth/README.md)
|
||||
- [PhoneAuth](PhoneAuth/README.md)
|
||||
- [Database](Database/README.md)
|
||||
- [Firestore](Firestore/README.md)
|
||||
- [Storage](Storage/README.md)
|
||||
|
||||
## Local Setup
|
||||
|
||||
If you'd like to contribute to FirebaseUI for iOS, you'll need to run the
|
||||
following commands to get your environment set up:
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/firebase/FirebaseUI-iOS.git
|
||||
$ cd FirebaseUI-iOS
|
||||
$ cd Auth # or PhoneAuth, Database, etc
|
||||
$ pod install
|
||||
```
|
||||
|
||||
Alternatively you can use `pod try FirebaseUI` to install the Objective-C or Swift sample projects.
|
||||
|
||||
## Sample Project Configuration
|
||||
|
||||
You'll have to configure your Xcode project in order to run the samples.
|
||||
|
||||
1. Your Xcode project should contain a `GoogleService-Info.plist`, downloaded from [Firebase console](https://console.firebase.google.com) when you add your app to a Firebase project.<br>
|
||||
Copy the `GoogleService-Info.plist` into the sample project folder (`samples/obj-c/GoogleService-Info.plist` or `samples/swift/GoogleService-Info.plist`).
|
||||
|
||||
1. Update URL Types.<br>
|
||||
Go to `Project Settings -> Info tab -> Url Types` and update values for:
|
||||
+ `REVERSED_CLIENT_ID` (get value from `GoogleService-Info.plist`)
|
||||
+ `fb{your-app-id}` (put Facebook App Id)
|
||||
|
||||
1. Update `Info.plist` with Facebook configuration values
|
||||
+ `FacebookAppID -> {your-app-id}` (put Facebook App Id)
|
||||
|
||||
1. Enable Keychain Sharing.<br>
|
||||
Facebook SDK requires keychain sharing.<br>
|
||||
This can be done here: `Project Settings -> Capabilities -> KeyChain Sharing -> ON`
|
||||
|
||||
1. Don't forget to configure your Firebase App Database using [Firebase console](https://console.firebase.google.com).<br>
|
||||
Database should contain appropriate read/write permissions and folders (`objc_demo-chat` and `swift_demo-chat` respectively)
|
||||
|
||||
1. In Order to use `Phone Auth` provider you should [Configure Push Notifications](#configure-apple-push-notifications)
|
||||
|
||||
#### Configure Apple Push Notifications
|
||||
|
||||
##### Enable silent push notifications in Xcode
|
||||
|
||||
* `Push Notification` - Under `Capabilities` tab in your app target choose `Push Notifications` and put the switch to the `On` position.
|
||||
* `Background Mode` - Under `Capabilities` tab in your app target choose `Background Modes` put the switch to the `On` position. In the list of available modes select `Background fetch` and `Remote notifications` (If available).
|
||||
|
||||
##### Upload APNS Certificate to Firebase
|
||||
|
||||
1. Create your `Provisioning APNS SSL Certificates` by following the steps on the following link.
|
||||
https://firebase.google.com/docs/cloud-messaging/ios/certs
|
||||
|
||||
1. Upload your `APNS Certificate` to Firebase:
|
||||
+ Inside your project in the Firebase console, select the gear icon, select `Project Settings`, and then select the `Cloud Messaging` tab.
|
||||
+ Select the `Upload Certificate` button for your development certificate, your production certificate, or both. At least one is required.
|
||||
+ For each certificate, select the `.p12 file`, and provide the password, if any. Make sure the `bundle ID` for this certificate matches the `bundle ID` of your app. Select `Save`.
|
||||
|
||||
## Contributing to FirebaseUI
|
||||
|
||||
### Contributor License Agreements
|
||||
|
||||
We'd love to accept your sample apps and patches! Before we can take them, we
|
||||
have to jump a couple of legal hurdles.
|
||||
|
||||
Please fill out either the individual or corporate Contributor License Agreement
|
||||
(CLA).
|
||||
|
||||
* If you are an individual writing original source code and you're sure you
|
||||
own the intellectual property, then you'll need to sign an [individual CLA]
|
||||
(https://developers.google.com/open-source/cla/individual).
|
||||
* If you work for a company that wants to allow you to contribute your work,
|
||||
then you'll need to sign a [corporate CLA]
|
||||
(https://developers.google.com/open-source/cla/corporate).
|
||||
|
||||
Follow either of the two links above to access the appropriate CLA and
|
||||
instructions for how to sign and return it. Once we receive it, we'll be able to
|
||||
accept your pull requests.
|
||||
|
||||
### Contribution Process
|
||||
|
||||
1. Submit an issue describing your proposed change to the repo in question.
|
||||
1. The repo owner will respond to your issue promptly.
|
||||
1. If your proposed change is accepted, and you haven't already done so, sign a
|
||||
Contributor License Agreement (see details above).
|
||||
1. Fork the desired repo, develop and test your code changes.
|
||||
1. Ensure that your code adheres to the existing style of the library to which
|
||||
you are contributing.
|
||||
1. Ensure that your code has an appropriate set of unit tests which all pass.
|
||||
1. Submit a pull request
|
||||
Reference in New Issue
Block a user