blob: 6581b5368d732240bbddfe9a1ce70245ba7dd157 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
/*
* 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 getUserPropertiesWithCallback:.
typedef void (^FIRAInteropUserPropertiesCallback)(NSDictionary<NSString *, id> *userProperties);
/// Connector for bridging communication between Firebase SDKs and FirebaseAnalytics API.
@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:(FIRAInteropUserPropertiesCallback)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
|
