Skip to content

Better Swift API completion usability #5748

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 3 commits into from
Jun 5, 2020
Merged

Better Swift API completion usability #5748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec905bc
Better Swift API completion usability
paulb777 Jun 1, 2020
2e270ef
docs
paulb777 Jun 1, 2020
d953393
changelog
paulb777 Jun 4, 2020
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
3 changes: 3 additions & 0 deletions FirebaseRemoteConfig/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# v4.5.1
- [changed] Removed typedefs from public API method signatures to improve Swift API usage from Xcode. (#5748)

# v4.5.0
- [changed] Updated `fetchAndActivateWithCompletionHandler:` implementation to activate asynchronously. (#5617)
- [fixed] Remove undefined class via removing unused proto generated source files. (#4334)
Expand Down
19 changes: 11 additions & 8 deletions FirebaseRemoteConfig/Sources/Public/FIRRemoteConfig.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,9 @@ NS_SWIFT_NAME(RemoteConfig)
- (nonnull instancetype)init __attribute__((unavailable("Use +remoteConfig instead.")));

/// Ensures initialization is complete and clients can begin querying for Remote Config values.
/// @param completionHandler Initialization complete callback.
/// @param completionHandler Initialization complete callback with error parameter.
- (void)ensureInitializedWithCompletionHandler:
(nonnull FIRRemoteConfigInitializationCompletion)completionHandler;
(void (^_Nonnull)(NSError *_Nullable initializationError))completionHandler;
#pragma mark - Fetch
/// Fetches Remote Config data with a callback. Call activateFetched to make fetched data available
/// to your app.
Expand All @@ -198,8 +198,9 @@ NS_SWIFT_NAME(RemoteConfig)
/// To stop the periodic sync, developers need to call `[FIRInstallations deleteWithCompletion:]`
/// and avoid calling this method again.
///
/// @param completionHandler Fetch operation callback.
- (void)fetchWithCompletionHandler:(nullable FIRRemoteConfigFetchCompletion)completionHandler;
/// @param completionHandler Fetch operation callback with status and error parameters.
- (void)fetchWithCompletionHandler:(void (^_Nullable)(FIRRemoteConfigFetchStatus status,
NSError *_Nullable error))completionHandler;

/// Fetches Remote Config data and sets a duration that specifies how long config data lasts.
/// Call activateFetched to make fetched data available to your app.
Expand All @@ -213,9 +214,10 @@ NS_SWIFT_NAME(RemoteConfig)
/// @param expirationDuration Override the (default or optionally set minimumFetchInterval property
/// in FIRRemoteConfigSettings) minimumFetchInterval for only the current request, in seconds.
/// Setting a value of 0 seconds will force a fetch to the backend.
/// @param completionHandler Fetch operation callback.
/// @param completionHandler Fetch operation callback with status and error parameters.
- (void)fetchWithExpirationDuration:(NSTimeInterval)expirationDuration
completionHandler:(nullable FIRRemoteConfigFetchCompletion)completionHandler;
completionHandler:(void (^_Nullable)(FIRRemoteConfigFetchStatus status,
NSError *_Nullable error))completionHandler;

/// Fetches Remote Config data and if successful, activates fetched data. Optional completion
/// handler callback is invoked after the attempted activation of data, if the fetch call succeeded.
Expand All @@ -226,9 +228,10 @@ NS_SWIFT_NAME(RemoteConfig)
/// To stop the periodic sync, developers need to call `[FIRInstallations deleteWithCompletion:]`
/// and avoid calling this method again.
///
/// @param completionHandler Fetch operation callback.
/// @param completionHandler Fetch operation callback with status and error parameters.
- (void)fetchAndActivateWithCompletionHandler:
(nullable FIRRemoteConfigFetchAndActivateCompletion)completionHandler;
(void (^_Nullable)(FIRRemoteConfigFetchAndActivateStatus status,
NSError *_Nullable error))completionHandler;

#pragma mark - Apply

Expand Down