WAFbImpl.git - Gitblit

3.9.7

lpw

2022-02-15 2e29a3a585524a054640bb6e7bdf26fe77ba1f17

commit \| author \| age
2e29a3	1	/*
L	2	* Copyright (c) Meta Platforms, Inc. and affiliates.
	3	* All rights reserved.
	4	*
	5	* This source code is licensed under the license found in the
	6	* LICENSE file in the root directory of this source tree.
	7	*/
	8
	9	#import <Foundation/Foundation.h>
	10
	11	#if !TARGET_OS_TV
	12	#import <WebKit/WebKit.h>
	13	#endif
	14
	15	#import <FBSDKCoreKit/FBSDKAppEventName.h>
	16	#import <FBSDKCoreKit/FBSDKAppEventParameterName.h>
	17	#import <FBSDKCoreKit/FBSDKAppEventUserDataType.h>
	18	#import <FBSDKCoreKit/FBSDKAppEventsFlushBehavior.h>
	19	#import <FBSDKCoreKit/FBSDKGraphRequest.h>
	20	#import <FBSDKCoreKit/FBSDKGraphRequestConnection.h>
	21	#import <FBSDKCoreKit/FBSDKProductAvailability.h>
	22	#import <FBSDKCoreKit/FBSDKProductCondition.h>
	23
	24	NS_ASSUME_NONNULL_BEGIN
	25
	26	@class FBSDKAccessToken;
	27
	28	/** optional plist key ("FacebookLoggingOverrideAppID") for setting `loggingOverrideAppID` */
	29	FOUNDATION_EXPORT NSString *const FBSDKAppEventsOverrideAppIDBundleKey
	30	NS_SWIFT_NAME(AppEventsOverrideAppIDBundleKey);
	31
	32	/**
	33
	34
	35	Client-side event logging for specialized application analytics available through Facebook App Insights
	36	and for use with Facebook Ads conversion tracking and optimization.
	37
	38
	39
	40	The `FBSDKAppEvents` static class has a few related roles:
	41
	42	+ Logging predefined and application-defined events to Facebook App Insights with a
	43	numeric value to sum across a large number of events, and an optional set of key/value
	44	parameters that define "segments" for this event (e.g., 'purchaserStatus' : 'frequent', or
	45	'gamerLevel' : 'intermediate')
	46
	47	+ Logging events to later be used for ads optimization around lifetime value.
	48
	49	+ Methods that control the way in which events are flushed out to the Facebook servers.
	50
	51	Here are some important characteristics of the logging mechanism provided by `FBSDKAppEvents`:
	52
	53	+ Events are not sent immediately when logged. They're cached and flushed out to the Facebook servers
	54	in a number of situations:
	55	- when an event count threshold is passed (currently 100 logged events).
	56	- when a time threshold is passed (currently 15 seconds).
	57	- when an app has gone to background and is then brought back to the foreground.
	58
	59	+ Events will be accumulated when the app is in a disconnected state, and sent when the connection is
	60	restored and one of the above 'flush' conditions are met.
	61
	62	+ The `FBSDKAppEvents` class is thread-safe in that events may be logged from any of the app's threads.
	63
	64	+ The developer can set the `flushBehavior` on `FBSDKAppEvents` to force the flushing of events to only
	65	occur on an explicit call to the `flush` method.
	66
	67	+ The developer can turn on console debug output for event logging and flushing to the server by using
	68	the `FBSDKLoggingBehaviorAppEvents` value in `[FBSettings setLoggingBehavior:]`.
	69
	70	Some things to note when logging events:
	71
	72	+ There is a limit on the number of unique event names an app can use, on the order of 1000.
	73	+ There is a limit to the number of unique parameter names in the provided parameters that can
	74	be used per event, on the order of 25. This is not just for an individual call, but for all
	75	invocations for that eventName.
	76	+ Event names and parameter names (the keys in the NSDictionary) must be between 2 and 40 characters, and
	77	must consist of alphanumeric characters, _, -, or spaces.
	78	+ The length of each parameter value can be no more than on the order of 100 characters.
	79
	80	*/
	81
	82	NS_SWIFT_NAME(AppEvents)
	83	@interface FBSDKAppEvents : NSObject
	84
	85	- (instancetype)init NS_UNAVAILABLE;
	86	+ (instancetype)new NS_UNAVAILABLE;
	87
	88	/**
	89	The shared instance of AppEvents.
	90	*/
	91	@property (class, nonatomic, readonly, strong) FBSDKAppEvents *shared;
	92
	93	/*
	94	* Control over event batching/flushing
	95	*/
	96
	97	/// The current event flushing behavior specifying when events are sent back to Facebook servers.
	98	@property (class, nonatomic) FBSDKAppEventsFlushBehavior flushBehavior
	99	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.flushBehavior` is deprecated and will be removed in the next major release; please use `AppEvents.shared.flushBehavior` instead");
	100
	101	/**
	102	Set the 'override' App ID for App Event logging.
	103
	104	In some cases, apps want to use one Facebook App ID for login and social presence and another
	105	for App Event logging. (An example is if multiple apps from the same company share an app ID for login, but
	106	want distinct logging.) By default, this value is `nil`, and defers to the `FBSDKAppEventsOverrideAppIDBundleKey`
	107	plist value. If that's not set, it defaults to `Settings.shared.appID`.
	108
	109	This should be set before any other calls are made to `AppEvents`. Thus, you should set it in your application
	110	delegate's `application(_:didFinishLaunchingWithOptions:)` method.
	111	*/
	112	@property (class, nullable, nonatomic, copy) NSString *loggingOverrideAppID
	113	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.loggingOverrideAppID` is deprecated and will be removed in the next major release; please use `AppEvents.shared.loggingOverrideAppID` instead");
	114
	115	/**
	116	The custom user ID to associate with all app events.
	117
	118	The userID is persisted until it is cleared by passing `nil`.
	119	*/
	120	@property (class, nullable, nonatomic, copy) NSString *userID
	121	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.userID` is deprecated and will be removed in the next major release; please use `AppEvents.shared.userID` instead");
	122
	123	/// Returns generated anonymous id that persisted with current install of the app
	124	@property (class, nonatomic, readonly) NSString *anonymousID
	125	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.anonymousID` is deprecated and will be removed in the next major release; please use `AppEvents.shared.anonymousID` instead");
	126
	127	/// The current event flushing behavior specifying when events are sent back to Facebook servers.
	128	@property (nonatomic) FBSDKAppEventsFlushBehavior flushBehavior;
	129
	130	/**
	131	Set the 'override' App ID for App Event logging.
	132
	133	In some cases, apps want to use one Facebook App ID for login and social presence and another
	134	for App Event logging. (An example is if multiple apps from the same company share an app ID for login, but
	135	want distinct logging.) By default, this value is `nil`, and defers to the `FBSDKAppEventsOverrideAppIDBundleKey`
	136	plist value. If that's not set, it defaults to `Settings.shared.appID`.
	137
	138	This should be set before any other calls are made to `AppEvents`. Thus, you should set it in your application
	139	delegate's `application(_:didFinishLaunchingWithOptions:)` method.
	140	*/
	141	@property (nullable, nonatomic, copy) NSString *loggingOverrideAppID;
	142
	143	/**
	144	The custom user ID to associate with all app events.
	145
	146	The userID is persisted until it is cleared by passing `nil`.
	147	*/
	148	@property (nullable, nonatomic, copy) NSString *userID;
	149
	150	/// Returns generated anonymous id that persisted with current install of the app
	151	@property (nonatomic, readonly) NSString *anonymousID;
	152
	153	/*
	154	* Basic event logging
	155	*/
	156
	157	/**
	158	Log an event with just an event name.
	159
	160	@param eventName The name of the event to record. Limitations on number of events and name length
	161	are given in the `AppEvents` documentation.
	162	*/
	163	+ (void)logEvent:(FBSDKAppEventName)eventName
	164	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logEvent(_:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logEvent(_:)` instead");
	165
	166	/**
	167	Log an event with just an event name.
	168
	169	@param eventName The name of the event to record. Limitations on number of events and name length
	170	are given in the `AppEvents` documentation.
	171	*/
	172	- (void)logEvent:(FBSDKAppEventName)eventName;
	173
	174	/**
	175	Log an event with an event name and a numeric value to be aggregated with other events of this name.
	176
	177	@param eventName The name of the event to record. Limitations on number of events and name length
	178	are given in the `AppEvents` documentation. Common event names are provided in `AppEvents.Name` constants.
	179
	180	@param valueToSum Amount to be aggregated into all events of this event name, and App Insights will report
	181	the cumulative and average value of this amount.
	182	*/
	183	+ (void)logEvent:(FBSDKAppEventName)eventName
	184	valueToSum:(double)valueToSum
	185	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logEvent(_:valueToSum:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logEvent(_:valueToSum:)` instead");
	186
	187	/**
	188	Log an event with an event name and a numeric value to be aggregated with other events of this name.
	189
	190	@param eventName The name of the event to record. Limitations on number of events and name length
	191	are given in the `AppEvents` documentation. Common event names are provided in `AppEvents.Name` constants.
	192
	193	@param valueToSum Amount to be aggregated into all events of this event name, and App Insights will report
	194	the cumulative and average value of this amount.
	195	*/
	196	- (void)logEvent:(FBSDKAppEventName)eventName
	197	valueToSum:(double)valueToSum;
	198
	199	/**
	200	Log an event with an event name and a set of key/value pairs in the parameters dictionary.
	201	Parameter limitations are described above.
	202
	203	@param eventName The name of the event to record. Limitations on number of events and name construction
	204	are given in the `AppEvents` documentation. Common event names are provided in `AppEvents.Name` constants.
	205
	206	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	207	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	208	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	209	are provided in `AppEvents.ParameterName` constants.
	210	*/
	211	+ (void)logEvent:(FBSDKAppEventName)eventName
	212	parameters:(nullable NSDictionary<FBSDKAppEventParameterName, id> *)parameters
	213	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logEvent(_:parameters:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logEvent(_:parameters:)` instead");
	214
	215	/**
	216	Log an event with an event name and a set of key/value pairs in the parameters dictionary.
	217	Parameter limitations are described above.
	218
	219	@param eventName The name of the event to record. Limitations on number of events and name construction
	220	are given in the `AppEvents` documentation. Common event names are provided in `AppEvents.Name` constants.
	221
	222	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	223	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	224	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	225	are provided in `AppEvents.ParameterName` constants.
	226	*/
	227	- (void)logEvent:(FBSDKAppEventName)eventName
	228	parameters:(nullable NSDictionary<FBSDKAppEventParameterName, id> *)parameters;
	229
	230	/**
	231	Log an event with an event name, a numeric value to be aggregated with other events of this name,
	232	and a set of key/value pairs in the parameters dictionary.
	233
	234	@param eventName The name of the event to record. Limitations on number of events and name construction
	235	are given in the `AppEvents` documentation. Common event names are provided in `AppEvents.Name` constants.
	236
	237	@param valueToSum Amount to be aggregated into all events of this event name, and App Insights will report
	238	the cumulative and average value of this amount.
	239
	240	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	241	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	242	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	243	are provided in `AppEvents.ParameterName` constants.
	244	*/
	245	+ (void)logEvent:(FBSDKAppEventName)eventName
	246	valueToSum:(double)valueToSum
	247	parameters:(nullable NSDictionary<FBSDKAppEventParameterName, id> *)parameters
	248	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logEvent(_:valueToSum:parameters:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logEvent(_:valueToSum:parameters:)` instead");
	249
	250	/**
	251	Log an event with an event name, a numeric value to be aggregated with other events of this name,
	252	and a set of key/value pairs in the parameters dictionary.
	253
	254	@param eventName The name of the event to record. Limitations on number of events and name construction
	255	are given in the `AppEvents` documentation. Common event names are provided in `AppEvents.Name` constants.
	256
	257	@param valueToSum Amount to be aggregated into all events of this event name, and App Insights will report
	258	the cumulative and average value of this amount.
	259
	260	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	261	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	262	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	263	are provided in `AppEvents.ParameterName` constants.
	264	*/
	265	- (void)logEvent:(FBSDKAppEventName)eventName
	266	valueToSum:(double)valueToSum
	267	parameters:(nullable NSDictionary<FBSDKAppEventParameterName, id> *)parameters;
	268
	269	/**
	270	Log an event with an event name, a numeric value to be aggregated with other events of this name,
	271	and a set of key/value pairs in the parameters dictionary.
	272
	273	@param eventName The name of the event to record. Limitations on number of events and name construction
	274	are given in the `AppEvents` documentation. Common event names are provided in `AppEvents.Name` constants.
	275
	276	@param valueToSum Amount to be aggregated into all events of this eventName, and App Insights will report
	277	the cumulative and average value of this amount. Note that this is an `NSNumber`, and a value of `nil` denotes
	278	that this event doesn't have a value associated with it for summation.
	279
	280	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	281	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	282	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	283	are provided in `AppEvents.ParameterName` constants.
	284
	285	@param accessToken The optional access token to log the event as.
	286	*/
	287	+ (void)logEvent:(FBSDKAppEventName)eventName
	288	valueToSum:(nullable NSNumber *)valueToSum
	289	parameters:(nullable NSDictionary<FBSDKAppEventParameterName, id> *)parameters
	290	accessToken:(nullable FBSDKAccessToken *)accessToken
	291	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logEvent(_:valueToSum:parameters:accessToken:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logEvent(_:valueToSum:parameters:accessToken:)` instead");
	292
	293	/**
	294	Log an event with an event name, a numeric value to be aggregated with other events of this name,
	295	and a set of key/value pairs in the parameters dictionary.
	296
	297	@param eventName The name of the event to record. Limitations on number of events and name construction
	298	are given in the `AppEvents` documentation. Common event names are provided in `AppEvents.Name` constants.
	299
	300	@param valueToSum Amount to be aggregated into all events of this eventName, and App Insights will report
	301	the cumulative and average value of this amount. Note that this is an `NSNumber`, and a value of `nil` denotes
	302	that this event doesn't have a value associated with it for summation.
	303
	304	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	305	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	306	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	307	are provided in `AppEvents.ParameterName` constants.
	308
	309	@param accessToken The optional access token to log the event as.
	310	*/
	311	- (void)logEvent:(FBSDKAppEventName)eventName
	312	valueToSum:(nullable NSNumber *)valueToSum
	313	parameters:(nullable NSDictionary<FBSDKAppEventParameterName, id> *)parameters
	314	accessToken:(nullable FBSDKAccessToken *)accessToken;
	315
	316	/*
	317	* Purchase logging
	318	*/
	319
	320	/**
	321	Log a purchase of the specified amount, in the specified currency.
	322
	323	@param purchaseAmount Purchase amount to be logged, as expressed in the specified currency. This value
	324	will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346).
	325
	326	@param currency Currency string (e.g., "USD", "EUR", "GBP"); see ISO-4217 for
	327	specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>.
	328
	329	This event immediately triggers a flush of the `AppEvents` event queue, unless the `flushBehavior` is set
	330	to `FBSDKAppEventsFlushBehaviorExplicitOnly`.
	331	*/
	332	+ (void)logPurchase:(double)purchaseAmount
	333	currency:(NSString *)currency
	334	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logPurchase(_:currency:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logPurchase(amount:currency:)` instead");
	335
	336	/**
	337	Log a purchase of the specified amount, in the specified currency.
	338
	339	@param purchaseAmount Purchase amount to be logged, as expressed in the specified currency. This value
	340	will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346).
	341
	342	@param currency Currency string (e.g., "USD", "EUR", "GBP"); see ISO-4217 for
	343	specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>.
	344
	345	This event immediately triggers a flush of the `AppEvents` event queue, unless the `flushBehavior` is set
	346	to `FBSDKAppEventsFlushBehaviorExplicitOnly`.
	347	*/
	348	// UNCRUSTIFY_FORMAT_OFF
	349	- (void)logPurchase:(double)purchaseAmount currency:(NSString *)currency
	350	NS_SWIFT_NAME(logPurchase(amount:currency:));
	351	// UNCRUSTIFY_FORMAT_ON
	352
	353	/**
	354	Log a purchase of the specified amount, in the specified currency, also providing a set of
	355	additional characteristics describing the purchase.
	356
	357	@param purchaseAmount Purchase amount to be logged, as expressed in the specified currency.This value
	358	will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346).
	359
	360	@param currency Currency string (e.g., "USD", "EUR", "GBP"); see ISO-4217 for
	361	specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>.
	362
	363	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	364	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	365	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	366	are provided in `AppEvents.ParameterName` constants.
	367
	368	This event immediately triggers a flush of the `AppEvents` event queue, unless the `flushBehavior` is set
	369	to `FBSDKAppEventsFlushBehaviorExplicitOnly`.
	370	*/
	371	+ (void)logPurchase:(double)purchaseAmount
	372	currency:(NSString *)currency
	373	parameters:(nullable NSDictionary<NSString , id> )parameters
	374	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logPurchase(_:currency:parameters:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logPurchase(amount:currency:parameters:)` instead");
	375
	376	/**
	377	Log a purchase of the specified amount, in the specified currency, also providing a set of
	378	additional characteristics describing the purchase.
	379
	380	@param purchaseAmount Purchase amount to be logged, as expressed in the specified currency.This value
	381	will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346).
	382
	383	@param currency Currency string (e.g., "USD", "EUR", "GBP"); see ISO-4217 for
	384	specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>.
	385
	386	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	387	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	388	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	389	are provided in `AppEvents.ParameterName` constants.
	390
	391	This event immediately triggers a flush of the `AppEvents` event queue, unless the `flushBehavior` is set
	392	to `FBSDKAppEventsFlushBehaviorExplicitOnly`.
	393	*/
	394	// UNCRUSTIFY_FORMAT_OFF
	395	- (void)logPurchase:(double)purchaseAmount
	396	currency:(NSString *)currency
	397	parameters:(nullable NSDictionary<NSString , id> )parameters
	398	NS_SWIFT_NAME(logPurchase(amount:currency:parameters:));
	399	// UNCRUSTIFY_FORMAT_ON
	400
	401	/**
	402	Log a purchase of the specified amount, in the specified currency, also providing a set of
	403	additional characteristics describing the purchase.
	404
	405	@param purchaseAmount Purchase amount to be logged, as expressed in the specified currency.This value
	406	will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346).
	407
	408	@param currency Currency string (e.g., "USD", "EUR", "GBP"); see ISO-4217 for
	409	specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>.
	410
	411	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	412	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	413	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	414	are provided in `AppEvents.ParameterName` constants.
	415
	416	@param accessToken The optional access token to log the event as.
	417
	418	This event immediately triggers a flush of the `AppEvents` event queue, unless the `flushBehavior` is set
	419	to `FBSDKAppEventsFlushBehaviorExplicitOnly`.
	420	*/
	421	+ (void)logPurchase:(double)purchaseAmount
	422	currency:(NSString *)currency
	423	parameters:(nullable NSDictionary<NSString , id> )parameters
	424	accessToken:(nullable FBSDKAccessToken *)accessToken
	425	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logPurchase(_:currency:parameters:accessToken:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logPurchase(amount:currency:parameters:accessToken:)` instead");
	426
	427	/**
	428	Log a purchase of the specified amount, in the specified currency, also providing a set of
	429	additional characteristics describing the purchase.
	430
	431	@param purchaseAmount Purchase amount to be logged, as expressed in the specified currency.This value
	432	will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346).
	433
	434	@param currency Currency string (e.g., "USD", "EUR", "GBP"); see ISO-4217 for
	435	specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>.
	436
	437	@param parameters Arbitrary parameter dictionary of characteristics. The keys to this dictionary must
	438	be `NSString`s, and the values are expected to be `NSString` or `NSNumber`. Limitations on the number of
	439	parameters and name construction are given in the `AppEvents` documentation. Commonly used parameter names
	440	are provided in `AppEvents.ParameterName` constants.
	441
	442	@param accessToken The optional access token to log the event as.
	443
	444	This event immediately triggers a flush of the `AppEvents` event queue, unless the `flushBehavior` is set
	445	to `FBSDKAppEventsFlushBehaviorExplicitOnly`.
	446	*/
	447	// UNCRUSTIFY_FORMAT_OFF
	448	- (void)logPurchase:(double)purchaseAmount
	449	currency:(NSString *)currency
	450	parameters:(nullable NSDictionary<NSString , id> )parameters
	451	accessToken:(nullable FBSDKAccessToken *)accessToken
	452	NS_SWIFT_NAME(logPurchase(amount:currency:parameters:accessToken:));
	453	// UNCRUSTIFY_FORMAT_ON
	454
	455	/*
	456	* Push Notifications Logging
	457	*/
	458
	459	/**
	460	Log an app event that tracks that the application was open via Push Notification.
	461
	462	@param payload Notification payload received via `UIApplicationDelegate`.
	463	*/
	464	+ (void)logPushNotificationOpen:(NSDictionary<NSString , id> )payload
	465	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logPushNotificationOpen(_:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logPushNotificationOpen(payload:)` instead");
	466
	467	/**
	468	Log an app event that tracks that the application was open via Push Notification.
	469
	470	@param payload Notification payload received via `UIApplicationDelegate`.
	471	*/
	472	// UNCRUSTIFY_FORMAT_OFF
	473	- (void)logPushNotificationOpen:(NSDictionary<NSString , id> )payload
	474	NS_SWIFT_NAME(logPushNotificationOpen(payload:));
	475	// UNCRUSTIFY_FORMAT_ON
	476
	477	/**
	478	Log an app event that tracks that a custom action was taken from a push notification.
	479
	480	@param payload Notification payload received via `UIApplicationDelegate`.
	481	@param action Name of the action that was taken.
	482	*/
	483	+ (void)logPushNotificationOpen:(NSDictionary<NSString , id> )payload action:(NSString *)action
	484	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logPushNotificationOpen(_:action:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logPushNotificationOpen(payload:action:)` instead");
	485
	486	/**
	487	Log an app event that tracks that a custom action was taken from a push notification.
	488
	489	@param payload Notification payload received via `UIApplicationDelegate`.
	490	@param action Name of the action that was taken.
	491	*/
	492	// UNCRUSTIFY_FORMAT_OFF
	493	- (void)logPushNotificationOpen:(NSDictionary<NSString , id> )payload action:(NSString *)action
	494	NS_SWIFT_NAME(logPushNotificationOpen(payload:action:));
	495	// UNCRUSTIFY_FORMAT_ON
	496
	497	/**
	498	Uploads product catalog product item as an app event
	499
	500	@param itemID Unique ID for the item. Can be a variant for a product.
	501	Max size is 100.
	502	@param availability If item is in stock. Accepted values are:
	503	in stock - Item ships immediately
	504	out of stock - No plan to restock
	505	preorder - Available in future
	506	available for order - Ships in 1-2 weeks
	507	discontinued - Discontinued
	508	@param condition Product condition: new, refurbished or used.
	509	@param description Short text describing product. Max size is 5000.
	510	@param imageLink Link to item image used in ad.
	511	@param link Link to merchant's site where someone can buy the item.
	512	@param title Title of item.
	513	@param priceAmount Amount of purchase, in the currency specified by the 'currency'
	514	parameter. This value will be rounded to the thousandths place
	515	(e.g., 12.34567 becomes 12.346).
	516	@param currency Currency string (e.g., "USD", "EUR", "GBP"); see ISO-4217 for
	517	specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>.
	518	@param gtin Global Trade Item Number including UPC, EAN, JAN and ISBN
	519	@param mpn Unique manufacture ID for product
	520	@param brand Name of the brand
	521	Note: Either gtin, mpn or brand is required.
	522	@param parameters Optional fields for deep link specification.
	523	*/
	524	+ (void)logProductItem:(NSString *)itemID
	525	availability:(FBSDKProductAvailability)availability
	526	condition:(FBSDKProductCondition)condition
	527	description:(NSString *)description
	528	imageLink:(NSString *)imageLink
	529	link:(NSString *)link
	530	title:(NSString *)title
	531	priceAmount:(double)priceAmount
	532	currency:(NSString *)currency
	533	gtin:(nullable NSString *)gtin
	534	mpn:(nullable NSString *)mpn
	535	brand:(nullable NSString *)brand
	536	parameters:(nullable NSDictionary<NSString , id> )parameters
	537	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.logProductItem(_:availability:condition:description:imageLink:link:title:priceAmount:currency:gtin:mpn:brand:parameters:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.logProductItem(id:availability:condition:description:imageLink:link:title:priceAmount:currency:gtin:mpn:brand:parameters:)` instead");
	538
	539	/**
	540	Uploads product catalog product item as an app event
	541
	542	@param itemID Unique ID for the item. Can be a variant for a product.
	543	Max size is 100.
	544	@param availability If item is in stock. Accepted values are:
	545	in stock - Item ships immediately
	546	out of stock - No plan to restock
	547	preorder - Available in future
	548	available for order - Ships in 1-2 weeks
	549	discontinued - Discontinued
	550	@param condition Product condition: new, refurbished or used.
	551	@param description Short text describing product. Max size is 5000.
	552	@param imageLink Link to item image used in ad.
	553	@param link Link to merchant's site where someone can buy the item.
	554	@param title Title of item.
	555	@param priceAmount Amount of purchase, in the currency specified by the 'currency'
	556	parameter. This value will be rounded to the thousandths place
	557	(e.g., 12.34567 becomes 12.346).
	558	@param currency Currency string (e.g., "USD", "EUR", "GBP"); see ISO-4217 for
	559	specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>.
	560	@param gtin Global Trade Item Number including UPC, EAN, JAN and ISBN
	561	@param mpn Unique manufacture ID for product
	562	@param brand Name of the brand
	563	Note: Either gtin, mpn or brand is required.
	564	@param parameters Optional fields for deep link specification.
	565	*/
	566	// UNCRUSTIFY_FORMAT_OFF
	567	- (void)logProductItem:(NSString *)itemID
	568	availability:(FBSDKProductAvailability)availability
	569	condition:(FBSDKProductCondition)condition
	570	description:(NSString *)description
	571	imageLink:(NSString *)imageLink
	572	link:(NSString *)link
	573	title:(NSString *)title
	574	priceAmount:(double)priceAmount
	575	currency:(NSString *)currency
	576	gtin:(nullable NSString *)gtin
	577	mpn:(nullable NSString *)mpn
	578	brand:(nullable NSString *)brand
	579	parameters:(nullable NSDictionary<NSString , id> )parameters
	580	NS_SWIFT_NAME(logProductItem(id:availability:condition:description:imageLink:link:title:priceAmount:currency:gtin:mpn:brand:parameters:));
	581	// UNCRUSTIFY_FORMAT_ON
	582
	583	/**
	584
	585	Notifies the events system that the app has launched and, when appropriate, logs an "activated app" event.
	586	This function is called automatically from FBSDKApplicationDelegate applicationDidBecomeActive, unless
	587	one overrides 'FacebookAutoLogAppEventsEnabled' key to false in the project info plist file.
	588	In case 'FacebookAutoLogAppEventsEnabled' is set to false, then it should typically be placed in the
	589	app delegates' `applicationDidBecomeActive:` method.
	590
	591	This method also takes care of logging the event indicating the first time this app has been launched, which, among other things, is used to
	592	track user acquisition and app install ads conversions.
	593
	594
	595
	596	`activateApp` will not log an event on every app launch, since launches happen every time the app is backgrounded and then foregrounded.
	597	"activated app" events will be logged when the app has not been active for more than 60 seconds. This method also causes a "deactivated app"
	598	event to be logged when sessions are "completed", and these events are logged with the session length, with an indication of how much
	599	time has elapsed between sessions, and with the number of background/foreground interruptions that session had. This data
	600	is all visible in your app's App Events Insights.
	601	*/
	602	- (void)activateApp;
	603
	604	/*
	605	* Push Notifications Registration and Uninstall Tracking
	606	*/
	607
	608	/**
	609	Sets and sends device token to register the current application for push notifications.
	610
	611	Sets and sends a device token from the `Data` representation that you get from
	612	`UIApplicationDelegate.application(_:didRegisterForRemoteNotificationsWithDeviceToken:)`.
	613
	614	@param deviceToken Device token data.
	615	*/
	616	+ (void)setPushNotificationsDeviceToken:(nullable NSData *)deviceToken
	617	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.setPushNotificationsDeviceToken(_:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.setPushNotificationsDeviceToken(_:)` instead");
	618
	619	/**
	620	Sets and sends device token to register the current application for push notifications.
	621
	622	Sets and sends a device token from the `Data` representation that you get from
	623	`UIApplicationDelegate.application(_:didRegisterForRemoteNotificationsWithDeviceToken:)`.
	624
	625	@param deviceToken Device token data.
	626	*/
	627	- (void)setPushNotificationsDeviceToken:(nullable NSData *)deviceToken;
	628
	629	/**
	630	Sets and sends device token string to register the current application for push notifications.
	631
	632	Sets and sends a device token string
	633
	634	@param deviceTokenString Device token string.
	635	*/
	636	// UNCRUSTIFY_FORMAT_OFF
	637	+ (void)setPushNotificationsDeviceTokenString:(nullable NSString *)deviceTokenString
	638	NS_SWIFT_NAME(setPushNotificationsDeviceToken(_:))
	639	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.setPushNotificationsDeviceToken(_:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.setPushNotificationsDeviceToken(_:)` instead");
	640	// UNCRUSTIFY_FORMAT_ON
	641
	642	/**
	643	Sets and sends device token string to register the current application for push notifications.
	644
	645	Sets and sends a device token string
	646
	647	@param deviceTokenString Device token string.
	648	*/
	649	// UNCRUSTIFY_FORMAT_OFF
	650	- (void)setPushNotificationsDeviceTokenString:(nullable NSString *)deviceTokenString
	651	NS_SWIFT_NAME(setPushNotificationsDeviceToken(_:));
	652	// UNCRUSTIFY_FORMAT_ON
	653
	654	/**
	655	Explicitly kick off flushing of events to Facebook. This is an asynchronous method, but it does initiate an immediate
	656	kick off. Server failures will be reported through the NotificationCenter with notification ID `FBSDKAppEventsLoggingResultNotification`.
	657	*/
	658	+ (void)flush
	659	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.flush()` is deprecated and will be removed in the next major release; please use `AppEvents.shared.flush()` instead");
	660
	661	/**
	662	Explicitly kick off flushing of events to Facebook. This is an asynchronous method, but it does initiate an immediate
	663	kick off. Server failures will be reported through the NotificationCenter with notification ID `FBSDKAppEventsLoggingResultNotification`.
	664	*/
	665	- (void)flush;
	666
	667	/**
	668	Creates a request representing the Graph API call to retrieve a Custom Audience "third party ID" for the app's Facebook user.
	669	Callers will send this ID back to their own servers, collect up a set to create a Facebook Custom Audience with,
	670	and then use the resultant Custom Audience to target ads.
	671
	672	The JSON in the request's response will include a "custom_audience_third_party_id" key/value pair with the value being the ID retrieved.
	673	This ID is an encrypted encoding of the Facebook user's ID and the invoking Facebook app ID.
	674	Multiple calls with the same user will return different IDs, thus these IDs cannot be used to correlate behavior
	675	across devices or applications, and are only meaningful when sent back to Facebook for creating Custom Audiences.
	676
	677	The ID retrieved represents the Facebook user identified in the following way: if the specified access token is valid,
	678	the ID will represent the user associated with that token; otherwise the ID will represent the user logged into the
	679	native Facebook app on the device. If there is no native Facebook app, no one is logged into it, or the user has opted out
	680	at the iOS level from ad tracking, then a `nil` ID will be returned.
	681
	682	This method returns `nil` if either the user has opted-out (via iOS) from Ad Tracking, the app itself has limited event usage
	683	via the `Settings.shared.isEventDataUsageLimited` flag, or a specific Facebook user cannot be identified.
	684
	685	@param accessToken The access token to use to establish the user's identity for users logged into Facebook through this app.
	686	If `nil`, then `AccessToken.current` is used.
	687	*/
	688	+ (nullable FBSDKGraphRequest )requestForCustomAudienceThirdPartyIDWithAccessToken:(nullable FBSDKAccessToken )accessToken
	689	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.requestForCustomAudienceThirdPartyID(with:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.requestForCustomAudienceThirdPartyID(accessToken:)` instead");
	690
	691	/**
	692	Creates a request representing the Graph API call to retrieve a Custom Audience "third party ID" for the app's Facebook user.
	693	Callers will send this ID back to their own servers, collect up a set to create a Facebook Custom Audience with,
	694	and then use the resultant Custom Audience to target ads.
	695
	696	The JSON in the request's response will include a "custom_audience_third_party_id" key/value pair with the value being the ID retrieved.
	697	This ID is an encrypted encoding of the Facebook user's ID and the invoking Facebook app ID.
	698	Multiple calls with the same user will return different IDs, thus these IDs cannot be used to correlate behavior
	699	across devices or applications, and are only meaningful when sent back to Facebook for creating Custom Audiences.
	700
	701	The ID retrieved represents the Facebook user identified in the following way: if the specified access token is valid,
	702	the ID will represent the user associated with that token; otherwise the ID will represent the user logged into the
	703	native Facebook app on the device. If there is no native Facebook app, no one is logged into it, or the user has opted out
	704	at the iOS level from ad tracking, then a `nil` ID will be returned.
	705
	706	This method returns `nil` if either the user has opted-out (via iOS) from Ad Tracking, the app itself has limited event usage
	707	via the `Settings.shared.isEventDataUsageLimited` flag, or a specific Facebook user cannot be identified.
	708
	709	@param accessToken The access token to use to establish the user's identity for users logged into Facebook through this app.
	710	If `nil`, then `AccessToken.current` is used.
	711	*/
	712	// UNCRUSTIFY_FORMAT_OFF
	713	- (nullable FBSDKGraphRequest )requestForCustomAudienceThirdPartyIDWithAccessToken:(nullable FBSDKAccessToken )accessToken
	714	NS_SWIFT_NAME(requestForCustomAudienceThirdPartyID(accessToken:));
	715	// UNCRUSTIFY_FORMAT_ON
	716
	717	/**
	718	Clears the custom user ID to associate with all app events.
	719	*/
	720	+ (void)clearUserID
	721	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.clearUserID` is deprecated and will be removed in the next major release, please set `AppEvents.shared.userID` to `nil` instead");
	722
	723	/**
	724	Sets custom user data to associate with all app events. All user data are hashed
	725	and used to match Facebook user from this instance of an application.
	726
	727	The user data will be persisted between application instances.
	728
	729	@param email user's email
	730	@param firstName user's first name
	731	@param lastName user's last name
	732	@param phone user's phone
	733	@param dateOfBirth user's date of birth
	734	@param gender user's gender
	735	@param city user's city
	736	@param state user's state
	737	@param zip user's zip
	738	@param country user's country
	739	*/
	740
	741	// UNCRUSTIFY_FORMAT_OFF
	742	+ (void)setUserEmail:(nullable NSString *)email
	743	firstName:(nullable NSString *)firstName
	744	lastName:(nullable NSString *)lastName
	745	phone:(nullable NSString *)phone
	746	dateOfBirth:(nullable NSString *)dateOfBirth
	747	gender:(nullable NSString *)gender
	748	city:(nullable NSString *)city
	749	state:(nullable NSString *)state
	750	zip:(nullable NSString *)zip
	751	country:(nullable NSString *)country
	752	NS_SWIFT_NAME(setUser(email:firstName:lastName:phone:dateOfBirth:gender:city:state:zip:country:))
	753	DEPRECATED_MSG_ATTRIBUTE("Class methods for setting user information are deprecated and will be removed in the next major release. Please use the instance method versions instead.");
	754	// UNCRUSTIFY_FORMAT_ON
	755
	756	/**
	757	Sets custom user data to associate with all app events. All user data are hashed
	758	and used to match Facebook user from this instance of an application.
	759
	760	The user data will be persisted between application instances.
	761
	762	@param email user's email
	763	@param firstName user's first name
	764	@param lastName user's last name
	765	@param phone user's phone
	766	@param dateOfBirth user's date of birth
	767	@param gender user's gender
	768	@param city user's city
	769	@param state user's state
	770	@param zip user's zip
	771	@param country user's country
	772	*/
	773
	774	// UNCRUSTIFY_FORMAT_OFF
	775	- (void)setUserEmail:(nullable NSString *)email
	776	firstName:(nullable NSString *)firstName
	777	lastName:(nullable NSString *)lastName
	778	phone:(nullable NSString *)phone
	779	dateOfBirth:(nullable NSString *)dateOfBirth
	780	gender:(nullable NSString *)gender
	781	city:(nullable NSString *)city
	782	state:(nullable NSString *)state
	783	zip:(nullable NSString *)zip
	784	country:(nullable NSString *)country
	785	NS_SWIFT_NAME(setUser(email:firstName:lastName:phone:dateOfBirth:gender:city:state:zip:country:));
	786	// UNCRUSTIFY_FORMAT_ON
	787
	788	/**
	789	Returns the set user data else nil
	790	*/
	791	+ (nullable NSString *)getUserData
	792	DEPRECATED_MSG_ATTRIBUTE("Class methods for getting user information are deprecated and will be removed in the next major release. Please use the instance method versions instead.");
	793
	794	/**
	795	Returns the set user data else nil
	796	*/
	797	- (nullable NSString *)getUserData;
	798
	799	/**
	800	Clears the current user data
	801	*/
	802	+ (void)clearUserData
	803	DEPRECATED_MSG_ATTRIBUTE("Class methods for setting user information are deprecated and will be removed in the next major release. Please use the instance method versions instead.");
	804
	805	/**
	806	Clears the current user data
	807	*/
	808	- (void)clearUserData;
	809
	810	/**
	811	Sets custom user data to associate with all app events. All user data are hashed
	812	and used to match Facebook user from this instance of an application.
	813
	814	The user data will be persisted between application instances.
	815
	816	@param data data
	817	@param type data type, e.g. FBSDKAppEventEmail, FBSDKAppEventPhone
	818	*/
	819	+ (void)setUserData:(nullable NSString *)data
	820	forType:(FBSDKAppEventUserDataType)type
	821	DEPRECATED_MSG_ATTRIBUTE("Class methods for setting user information are deprecated and will be removed in the next major release. Please use the instance method versions instead.");
	822
	823	/**
	824	Sets custom user data to associate with all app events. All user data are hashed
	825	and used to match Facebook user from this instance of an application.
	826
	827	The user data will be persisted between application instances.
	828
	829	@param data data
	830	@param type data type, e.g. FBSDKAppEventEmail, FBSDKAppEventPhone
	831	*/
	832	- (void)setUserData:(nullable NSString *)data
	833	forType:(FBSDKAppEventUserDataType)type;
	834
	835	/**
	836	Clears the current user data of certain type
	837	*/
	838	+ (void)clearUserDataForType:(FBSDKAppEventUserDataType)type
	839	DEPRECATED_MSG_ATTRIBUTE("Class methods for setting user information are deprecated and will be removed in the next major release. Please use the instance method versions instead.");
	840
	841	/**
	842	Clears the current user data of certain type
	843	*/
	844	- (void)clearUserDataForType:(FBSDKAppEventUserDataType)type;
	845
	846	#if !TARGET_OS_TV
	847	/**
	848	Intended to be used as part of a hybrid webapp.
	849	If you call this method, the FB SDK will inject a new JavaScript object into your webview.
	850	If the FB Pixel is used within the webview, and references the app ID of this app,
	851	then it will detect the presence of this injected JavaScript object
	852	and pass Pixel events back to the FB SDK for logging using the AppEvents framework.
	853
	854	@param webView The webview to augment with the additional JavaScript behavior
	855	*/
	856	+ (void)augmentHybridWKWebView:(WKWebView *)webView
	857	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.augmentHybridWKWebView(_:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.augmentHybridWebView(_:)` instead");
	858
	859	/**
	860	Intended to be used as part of a hybrid webapp.
	861	If you call this method, the FB SDK will inject a new JavaScript object into your webview.
	862	If the FB Pixel is used within the webview, and references the app ID of this app,
	863	then it will detect the presence of this injected JavaScript object
	864	and pass Pixel events back to the FB SDK for logging using the AppEvents framework.
	865
	866	@param webView The webview to augment with the additional JavaScript behavior
	867	*/
	868	- (void)augmentHybridWebView:(WKWebView *)webView;
	869	#endif
	870
	871	/*
	872	* Unity helper functions
	873	*/
	874
	875	/**
	876	Set whether Unity is already initialized.
	877
	878	@param isUnityInit Whether Unity is initialized.
	879
	880	*/
	881	+ (void)setIsUnityInit:(BOOL)isUnityInit
	882	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.setIsUnityInit(_:)` is deprecated and will be removed in the next major release; please use `AppEvents.shared.setIsUnityInitialized(_:)` instead");
	883
	884	/**
	885	Set whether Unity is already initialized.
	886
	887	@param isUnityInitialized Whether Unity is initialized.
	888
	889	*/
	890	- (void)setIsUnityInitialized:(BOOL)isUnityInitialized;
	891
	892	/**
	893	Send event bindings to Unity
	894	*/
	895	+ (void)sendEventBindingsToUnity
	896	DEPRECATED_MSG_ATTRIBUTE("`AppEvents.sendEventBindingsToUnity()` is deprecated and will be removed in the next major release; please use `AppEvents.shared.sendEventBindingsToUnity()` instead");
	897
	898	/**
	899	Send event bindings to Unity
	900	*/
	901	- (void)sendEventBindingsToUnity;
	902
	903	/*
	904	* SDK Specific Event Logging
	905	* Do not call directly outside of the SDK itself.
	906	*/
	907
	908	/**
	909	Internal Type exposed to facilitate transition to Swift.
	910	API Subject to change or removal without warning. Do not use.
	911
	912	@warning INTERNAL - DO NOT USE
	913	*/
	914	- (void)logInternalEvent:(FBSDKAppEventName)eventName
	915	parameters:(nullable NSDictionary<NSString , id> )parameters
	916	isImplicitlyLogged:(BOOL)isImplicitlyLogged;
	917
	918	/**
	919	Internal Type exposed to facilitate transition to Swift.
	920	API Subject to change or removal without warning. Do not use.
	921
	922	@warning INTERNAL - DO NOT USE
	923	*/
	924	- (void)logInternalEvent:(FBSDKAppEventName)eventName
	925	parameters:(nullable NSDictionary<NSString , id> )parameters
	926	isImplicitlyLogged:(BOOL)isImplicitlyLogged
	927	accessToken:(FBSDKAccessToken *)accessToken;
	928
	929	@end
	930
	931	NS_ASSUME_NONNULL_END