Flurry.h

//
//  Flurry.h
//  Flurry iOS Analytics Agent
//
//  Copyright (c) 2021 Yahoo. All rights reserved.
//
// Methods in this header file are for use with Flurry Analytics

#import <UIKit/UIKit.h>
#if !TARGET_OS_WATCH
@class SKPaymentTransaction;
#endif
#if TARGET_OS_TV
@class JSContext;
#endif

#import "FlurrySessionBuilder.h"

typedef NS_ENUM(NSUInteger, FlurryPaymentTransactionState) {
    FlurryPaymentTransactionStatePurchasing NS_SWIFT_NAME(purchasing) = 0,
    FlurryPaymentTransactionStateSuccess NS_SWIFT_NAME(success),
    FlurryPaymentTransactionStateFailure NS_SWIFT_NAME(failure),
    FlurryPaymentTransactionStateRestored NS_SWIFT_NAME(restored),
    FlurryPaymentTransactionStateDeferred NS_SWIFT_NAME(deffered)
};


typedef NS_ENUM(NSUInteger, FlurryEventRecordStatus) {
    FlurryEventFailed NS_SWIFT_NAME(failed) = 0,
    FlurryEventRecorded NS_SWIFT_NAME(recorded),
    FlurryEventUniqueCountExceeded NS_SWIFT_NAME(uniqueCountExceeded),
    FlurryEventParamsCountExceeded NS_SWIFT_NAME(paramsCountExceeded),
    FlurryEventLogCountExceeded NS_SWIFT_NAME(logCountExceeded),
    FlurryEventLoggingDelayed NS_SWIFT_NAME(loggingDelayed),
    FlurryEventAnalyticsDisabled NS_SWIFT_NAME(analyticsDisabled),
    FlurryEventParametersMismatched NS_SWIFT_NAME(parametersMismatched)
};


typedef NS_ENUM(NSUInteger, FlurrySyndicationEvent){
    FlurrySyndicationReblog NS_SWIFT_NAME(reblog) = 0,
    FlurrySyndicationFastReblog NS_SWIFT_NAME(fastReblog),
    FlurrySyndicationSourceClick NS_SWIFT_NAME(sourceClick),
    FlurrySyndicationLike NS_SWIFT_NAME(like),
    FlurrySyndicationShareClick NS_SWIFT_NAME(shareClick),
    FlurrySyndicationPostSend NS_SWIFT_NAME(postSend)
};

extern NSString* _Nonnull const kSyndicationiOSDeepLink;
extern NSString* _Nonnull const kSyndicationAndroidDeepLink;
extern NSString* _Nonnull const kSyndicationWebDeepLink;


typedef NS_ENUM(NSUInteger, FlurryTransactionRecordStatus) {
    FlurryTransactionRecordFailed NS_SWIFT_NAME(failed) = 0,
    FlurryTransactionRecorded NS_SWIFT_NAME(recorded),
    FlurryTransactionRecordExceeded NS_SWIFT_NAME(recordExceeded),
    FlurryTransactionRecodingDisabled NS_SWIFT_NAME(recordingDisabled)
};

#if !TARGET_OS_WATCH

@protocol FlurryDelegate <NSObject>

- (void)flurrySessionDidCreateWithInfo:(nonnull NSDictionary*)info;

@end

#if TARGET_OS_IOS

@protocol FlurryFetchObserver <NSObject>

@optional

- (void)onFetched:(NSDictionary<NSString *, NSString *> *_Nullable)publisherData;

@end
#endif

@interface Flurry : NSObject {
}

#pragma mark - Pre-Session Calls


+ (nonnull NSString *)getFlurryAgentVersion;

+ (void)setShowErrorInLogEnabled:(BOOL)value
NS_SWIFT_NAME(set(showErrorInLogEnabled:));

+ (void)setLogLevel:(FlurryLogLevel)value
NS_SWIFT_NAME(set(logLevel:));



#pragma mark - Flurry Delegate setters

+ (void)setDelegate:(nonnull id<FlurryDelegate>)delegate
NS_SWIFT_NAME(set(delegate:));

+ (void)setDelegate:(nonnull id<FlurryDelegate>)delegate withCallbackQueue:(nonnull dispatch_queue_t)flurryCallbackQueue
NS_SWIFT_NAME(set(delegate:callbackQueue:));

#pragma mark - start session APIs'


+ (void)startSession:(nonnull NSString *)apiKey
NS_SWIFT_NAME(startSession(apiKey:));


+ (void) startSession:(nonnull NSString *)apiKey withOptions:(nullable id)options
NS_SWIFT_NAME(startSession(apiKey:options:));


+ (void) startSession:(nonnull NSString *)apiKey withOptions:(nullable id)options withSessionBuilder:(nullable FlurrySessionBuilder*) sessionBuilder
NS_SWIFT_NAME(startSession(apiKey:options:sessionBuilder:));


+ (void) startSession:(nonnull NSString *)apiKey withSessionBuilder:(nullable FlurrySessionBuilder *)sessionBuilder
NS_SWIFT_NAME(startSession(apiKey:sessionBuilder:));

#pragma mark - Session Details

+ (BOOL)activeSessionExists;

+ (nonnull NSString*)getSessionID;

#pragma mark - Manual session pausing

#if !TARGET_OS_TV

+ (void)pauseBackgroundSession;
#endif

#pragma mark - User Info Setters and Getters


+ (void)setUserID:(nullable NSString *)userID
NS_SWIFT_NAME(set(userId:));

+ (void)setAge:(int)age
NS_SWIFT_NAME(set(age:));

+ (void)setGender:(nonnull NSString *)gender
NS_SWIFT_NAME(set(gender:)); // user's gender m or f


+ (BOOL)trackPreciseLocation:(BOOL)state;

+ (void) setIAPReportingEnabled:(BOOL)value
NS_SWIFT_NAME(set(iapReportingEnabled:));


#pragma mark - Add sessionOrigin, originAttributes and sessionProperties

+ (void)addSessionOrigin:(nonnull NSString *)sessionOriginName
NS_SWIFT_NAME(add(sessionOriginName:));

+ (void)addSessionOrigin:(nonnull NSString *)sessionOriginName
            withDeepLink:(nonnull NSString *)deepLink
NS_SWIFT_NAME(add(sessionOriginName:deepLink:));

+ (void)sessionProperties:(nonnull NSDictionary *)parameters;

+ (void)addOrigin:(nonnull NSString *)originName
      withVersion:(nonnull NSString *)originVersion
NS_SWIFT_NAME(add(originName:originVersion:));

+ (void)addOrigin:(nonnull NSString *)originName
      withVersion:(nonnull NSString*)originVersion
   withParameters:(nullable NSDictionary *)parameters
NS_SWIFT_NAME(add(originName:originVersion:parameters:));

#pragma mark - Event Logging


+ (FlurryEventRecordStatus)logEvent:(nonnull NSString *)eventName
NS_SWIFT_NAME(log(eventName:));

+ (FlurryEventRecordStatus)logEvent:(nonnull NSString *)eventName
                     withParameters:(nullable NSDictionary *)parameters
NS_SWIFT_NAME(log(eventName:parameters:));

+ (FlurryEventRecordStatus) logEvent:(FlurrySyndicationEvent) syndicationEvent
                       syndicationID:(nonnull NSString *) syndicationID
                          parameters:(nullable NSDictionary *) parameters
NS_SWIFT_NAME(log(syndicationEvent:syndicationID:parameters:));

+ (void) logPaymentTransaction:(nonnull SKPaymentTransaction *)transaction
                statusCallback:(nullable void(^)(FlurryTransactionRecordStatus))statusCallback
NS_SWIFT_NAME(log(transaction:statusCallback:));


+ (void) logPaymentTransactionWithTransactionId:(nonnull NSString *)transactionId
                                                  productId:(nonnull NSString *)productId
                                                   quantity:(NSUInteger)quantity
                                                      price:(double)price
                                                   currency:(nonnull NSString *)currency
                                                productName:(nonnull NSString *)productName
                                           transactionState:(FlurryPaymentTransactionState)transactionState
                                          userDefinedParams:(nullable NSDictionary *)transactionParams
                                             statusCallback:(nullable void(^)(FlurryTransactionRecordStatus))statusCallback
NS_SWIFT_NAME(log(transactionId:productId:quantity:price:currency:productName:transactionState:transactionParams:statusCallback:));

#pragma mark - Timed Event Logging

+ (FlurryEventRecordStatus)logEvent:(nonnull NSString *)eventName timed:(BOOL)timed
NS_SWIFT_NAME(log(eventName:timed:));

+ (FlurryEventRecordStatus)logEvent:(nonnull NSString *)eventName withParameters:(nullable NSDictionary *)parameters timed:(BOOL)timed
NS_SWIFT_NAME(log(eventName:parameters:timed:));

+ (void)endTimedEvent:(nonnull NSString *)eventName withParameters:(nullable NSDictionary *)parameters
NS_SWIFT_NAME(endTimedEvent(eventName:parameters:));    // non-nil parameters will update the parameters

#pragma mark - Exceptions Logging

+ (void)logError:(nonnull NSString *)errorID
         message:(nullable NSString *)message
       exception:(nullable NSException *)exception
NS_SWIFT_NAME(log(errorId:message:exception:));

+ (void)logError:(nonnull NSString *)errorID
         message:(nullable NSString *)message
       exception:(nullable NSException *)exception
  withParameters:(nullable NSDictionary*)parameters
NS_SWIFT_NAME(log(errorId:message:exception:parameters:));

#pragma mark - Error Logging

+ (void)logError:(nonnull NSString *)errorID
         message:(nullable NSString *)message
           error:(nullable NSError *)error
NS_SWIFT_NAME(log(errorId:message:error:));

+ (void)logError:(nonnull NSString *)errorID
         message:(nullable NSString *)message
           error:(nullable NSError *)error
  withParameters:(nullable NSDictionary*)parameters
NS_SWIFT_NAME(log(errorId:message:error:parameters:));

+ (void)leaveBreadcrumb:(nonnull NSString*)breadcrumb;

#pragma mark - TVML JSContext

#if TARGET_OS_TV

+ (void)registerJSContextWithContext:(JSContext * _Nonnull)jscontext;
#endif

#pragma mark - Privacy dashboard

+ (void)openPrivacyDashboard:(nullable void(^)(BOOL success))completionHandler;

#if TARGET_OS_IOS
#pragma mark - Publisher Segmentation

+ (BOOL)isFetchFinished;

+ (void)registerFetchObserver:(id<FlurryFetchObserver> _Nonnull)observer withExecutionQueue:(dispatch_queue_t _Nonnull)queue
NS_SWIFT_NAME(registerFetchObserver(_:executionQueue:));

+ (void)unregisterFetchObserver:(id<FlurryFetchObserver> _Nonnull)observer;

+ (nullable NSDictionary<NSString *, NSString *> *)getPublisherData;

+ (void)fetch;

#endif

+ (void)setAppVersion:(nonnull NSString *)version
NS_SWIFT_NAME(set(appVersion:));

+ (void)setSessionContinueSeconds:(int)seconds
NS_SWIFT_NAME(set(sessionContinueSeconds:));

+ (void)setCountBackgroundSessions:(BOOL)value
NS_SWIFT_NAME(set(countBackgroundSessions:));


+ (BOOL)isInitialized;


@end

#endif