mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-11 22:55:59 +05:45
Ryan Wilson
e002709d2c
* Mark ObjC typedefs as unavailable in Swift. This is part of the larger Swift API improvements effort. These reduce visibility in autocomplete, and we've mostly migrated away from them already. This hides the unused type from the API surface to avoid cluttering the list of types avialable. * Revert FDL Test * Fix CombineSwift tests * Fixed Firestore tests * Revert unneeded changes for FDL internal headers.
69 lines
2.7 KiB
Objective-C
69 lines
2.7 KiB
Objective-C
/*
|
|
* 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>
|
|
|
|
@protocol FIRAnalyticsInteropListener;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/// Block typedef callback parameter to `getUserProperties(with:)`.
|
|
typedef void (^FIRAInteropUserPropertiesCallback)(NSDictionary<NSString *, id> *userProperties)
|
|
NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
|
|
|
|
/// Connector for bridging communication between Firebase SDKs and FirebaseAnalytics APIs.
|
|
@protocol FIRAnalyticsInterop
|
|
|
|
/// Sets user property when trigger event is logged. This API is only available in the SDK.
|
|
- (void)setConditionalUserProperty:(NSDictionary<NSString *, id> *)conditionalUserProperty;
|
|
|
|
/// Clears user property if set.
|
|
- (void)clearConditionalUserProperty:(NSString *)userPropertyName
|
|
forOrigin:(NSString *)origin
|
|
clearEventName:(NSString *)clearEventName
|
|
clearEventParameters:(NSDictionary<NSString *, NSString *> *)clearEventParameters;
|
|
|
|
/// Returns currently set user properties.
|
|
- (NSArray<NSDictionary<NSString *, NSString *> *> *)conditionalUserProperties:(NSString *)origin
|
|
propertyNamePrefix:
|
|
(NSString *)propertyNamePrefix;
|
|
|
|
/// Returns the maximum number of user properties.
|
|
- (NSInteger)maxUserProperties:(NSString *)origin;
|
|
|
|
/// Returns the user properties to a callback function.
|
|
- (void)getUserPropertiesWithCallback:
|
|
(void (^)(NSDictionary<NSString *, id> *userProperties))callback;
|
|
|
|
/// Logs events.
|
|
- (void)logEventWithOrigin:(NSString *)origin
|
|
name:(NSString *)name
|
|
parameters:(nullable NSDictionary<NSString *, id> *)parameters;
|
|
|
|
/// Sets user property.
|
|
- (void)setUserPropertyWithOrigin:(NSString *)origin name:(NSString *)name value:(id)value;
|
|
|
|
/// Registers an Analytics listener for the given origin.
|
|
- (void)registerAnalyticsListener:(id<FIRAnalyticsInteropListener>)listener
|
|
withOrigin:(NSString *)origin;
|
|
|
|
/// Unregisters an Analytics listener for the given origin.
|
|
- (void)unregisterAnalyticsListenerWithOrigin:(NSString *)origin;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|