Skip to content

Add nullability annotations to public API #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2018
Merged

Add nullability annotations to public API #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f591569
Add nullability annotations to public API
nolanw Jan 12, 2018
c4acf06
Can't set a nil location.
nolanw Jan 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions GeoFire/API/GFCircleQuery.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
// Copyright (c) 2016 Firebase. All rights reserved.
//

NS_ASSUME_NONNULL_BEGIN

@interface GFCircleQuery : GFQuery

/**
Expand All @@ -21,3 +23,5 @@
@property (atomic, readwrite) double radius;

@end

NS_ASSUME_NONNULL_END
4 changes: 4 additions & 0 deletions GeoFire/API/GFQuery.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
#import <Foundation/Foundation.h>
#import <CoreLocation/CoreLocation.h>

NS_ASSUME_NONNULL_BEGIN

typedef NSUInteger FirebaseHandle;

@class GeoFire;
Expand Down Expand Up @@ -99,3 +101,5 @@ typedef void (^GFReadyBlock) (void);
- (void)removeAllObservers;

@end

NS_ASSUME_NONNULL_END
4 changes: 4 additions & 0 deletions GeoFire/API/GFRegionQuery.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

#import <MapKit/MapKit.h>

NS_ASSUME_NONNULL_BEGIN

@interface GFRegionQuery : GFQuery

/**
Expand All @@ -18,3 +20,5 @@
@property (atomic, readwrite) MKCoordinateRegion region;

@end

NS_ASSUME_NONNULL_END
12 changes: 8 additions & 4 deletions GeoFire/API/GeoFire.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@

@class FIRDatabaseReference;

typedef void (^GFCompletionBlock) (NSError *error);
typedef void (^GFCallbackBlock) (CLLocation *location, NSError *error);
NS_ASSUME_NONNULL_BEGIN

typedef void (^GFCompletionBlock) (NSError * _Nullable error);
typedef void (^GFCallbackBlock) (CLLocation * _Nullable location, NSError * _Nullable error);

/**
* A GeoFire instance is used to store geo location data at a Firebase location.
Expand Down Expand Up @@ -82,7 +84,7 @@ typedef void (^GFCallbackBlock) (CLLocation *location, NSError *error);
*/
- (void)setLocation:(CLLocation *)location
forKey:(NSString *)key
withCompletionBlock:(GFCompletionBlock)block;
withCompletionBlock:(nullable GFCompletionBlock)block;

/**
* Removes the location for a given key.
Expand All @@ -96,7 +98,7 @@ withCompletionBlock:(GFCompletionBlock)block;
* @param key The key for which the location is removed
* @param block The completion block that is called once the location was successfully updated on the server
*/
- (void)removeKey:(NSString *)key withCompletionBlock:(GFCompletionBlock)block;
- (void)removeKey:(NSString *)key withCompletionBlock:(nullable GFCompletionBlock)block;

/**
* Gets the current location for a key in GeoFire and calls the callback with the location or nil if there is no
Expand Down Expand Up @@ -128,3 +130,5 @@ withCompletionBlock:(GFCompletionBlock)block;
- (GFRegionQuery *)queryWithRegion:(MKCoordinateRegion)region;

@end

NS_ASSUME_NONNULL_END