| 1 |
efrain |
1 |
// Copyright 2019 Google
|
|
|
2 |
//
|
|
|
3 |
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
4 |
// you may not use this file except in compliance with the License.
|
|
|
5 |
// You may obtain a copy of the License at
|
|
|
6 |
//
|
|
|
7 |
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
8 |
//
|
|
|
9 |
// Unless required by applicable law or agreed to in writing, software
|
|
|
10 |
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
12 |
// See the License for the specific language governing permissions and
|
|
|
13 |
// limitations under the License.
|
|
|
14 |
|
|
|
15 |
#import <Foundation/Foundation.h>
|
|
|
16 |
|
|
|
17 |
NS_ASSUME_NONNULL_BEGIN
|
|
|
18 |
|
|
|
19 |
/// Default event name for when an experiment is set.
|
|
|
20 |
extern NSString *const FIRSetExperimentEventName NS_SWIFT_NAME(DefaultSetExperimentEventName);
|
|
|
21 |
/// Default event name for when an experiment is activated.
|
|
|
22 |
// clang-format off
|
|
|
23 |
// clang-format12 will merge lines and exceed 100 character limit.
|
|
|
24 |
extern NSString *const FIRActivateExperimentEventName
|
|
|
25 |
NS_SWIFT_NAME(DefaultActivateExperimentEventName);
|
|
|
26 |
/// Default event name for when an experiment is cleared.
|
|
|
27 |
extern NSString *const FIRClearExperimentEventName NS_SWIFT_NAME(DefaultClearExperimentEventName);
|
|
|
28 |
/// Default event name for when an experiment times out for being activated.
|
|
|
29 |
extern NSString *const FIRTimeoutExperimentEventName
|
|
|
30 |
NS_SWIFT_NAME(DefaultTimeoutExperimentEventName);
|
|
|
31 |
// clang-format on
|
|
|
32 |
/// Default event name for when an experiment is expired as it reaches the end of TTL.
|
|
|
33 |
extern NSString *const FIRExpireExperimentEventName NS_SWIFT_NAME(DefaultExpireExperimentEventName);
|
|
|
34 |
|
|
|
35 |
/// An Experiment Lifecycle Event Object that specifies the name of the experiment event to be
|
|
|
36 |
/// logged by Firebase Analytics.
|
|
|
37 |
NS_SWIFT_NAME(LifecycleEvents)
|
|
|
38 |
@interface FIRLifecycleEvents : NSObject
|
|
|
39 |
|
|
|
40 |
/// Event name for when an experiment is set. It is default to FIRSetExperimentEventName and can be
|
|
|
41 |
/// overridden. If experiment payload has a valid string of this field, always use experiment
|
|
|
42 |
/// payload.
|
|
|
43 |
@property(nonatomic, copy) NSString *setExperimentEventName;
|
|
|
44 |
|
|
|
45 |
/// Event name for when an experiment is activated. It is default to FIRActivateExperimentEventName
|
|
|
46 |
/// and can be overridden. If experiment payload has a valid string of this field, always use
|
|
|
47 |
/// experiment payload.
|
|
|
48 |
@property(nonatomic, copy) NSString *activateExperimentEventName;
|
|
|
49 |
|
|
|
50 |
/// Event name for when an experiment is cleared. It is default to FIRClearExperimentEventName and
|
|
|
51 |
/// can be overridden. If experiment payload has a valid string of this field, always use experiment
|
|
|
52 |
/// payload.
|
|
|
53 |
@property(nonatomic, copy) NSString *clearExperimentEventName;
|
|
|
54 |
/// Event name for when an experiment is timeout from being STANDBY. It is default to
|
|
|
55 |
/// FIRTimeoutExperimentEventName and can be overridden. If experiment payload has a valid string
|
|
|
56 |
/// of this field, always use experiment payload.
|
|
|
57 |
@property(nonatomic, copy) NSString *timeoutExperimentEventName;
|
|
|
58 |
|
|
|
59 |
/// Event name when an experiment is expired when it reaches the end of its TTL.
|
|
|
60 |
/// It is default to FIRExpireExperimentEventName and can be overridden. If experiment payload has a
|
|
|
61 |
/// valid string of this field, always use experiment payload.
|
|
|
62 |
@property(nonatomic, copy) NSString *expireExperimentEventName;
|
|
|
63 |
|
|
|
64 |
@end
|
|
|
65 |
|
|
|
66 |
NS_ASSUME_NONNULL_END
|