macOS Application Access¶

   target 'yourProjectName' do

   # Pods for your project
   pod 'FTMacOSSDK', '~>[latest_version]'

   end

  dependencies: [
    .package(url: "https://github.com/GuanceCloud/datakit-macos.git", .upToNextMajor(from: "[latest_version]"))
]

#import "FTMacOSSDK.h"

import FTMacOSSDK

// main.m 
#import "FTMacOSSDK.h"

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        // Setup code that might create autoreleased objects goes here.
        FTSDKConfig *config = [[FTSDKConfig alloc]initWithMetricsUrl:@"YOUR_ACCESS_SERVER_URL"];
        config.enableSDKDebugLog = YES;
        [FTSDKAgent startWithConfigOptions:config];
    }
    return NSApplicationMain(argc, argv);
}

import Cocoa
import FTMacOSSDK

let delegate = AppDelegate()
NSApplication.shared.delegate = delegate
// Installation SDK 
let config = FTSDKConfig.init(metricsUrl: "YOUR_ACCESS_SERVER_URL")
config.enableSDKDebugLog = true
FTSDKAgent.start(withConfigOptions: config)

_ = NSApplicationMain(CommandLine.argc, CommandLine.unsafeArgv)

   FTRumConfig *rumConfig = [[FTRumConfig alloc]initWithAppid:appid];
   rumConfig.enableTrackAppCrash = YES;
   rumConfig.enableTrackAppANR = YES;
   rumConfig.enableTrackAppFreeze = YES;
   rumConfig.enableTraceUserAction = YES;
   rumConfig.enableTraceUserVIew = YES;
   rumConfig.enableTraceUserResource = YES;
   rumConfig.errorMonitorType = FTErrorMonitorAll;
   rumConfig.deviceMetricsMonitorType = FTDeviceMetricsMonitorAll;
   [[FTSDKAgent sharedInstance] startRumWithConfigOptions:rumConfig];

   let rumConfig = FTRumConfig(appid: appid)
   rumConfig.enableTraceUserAction = true
   rumConfig.enableTrackAppANR = true
   rumConfig.enableTraceUserView = true
   rumConfig.enableTraceUserResource = true
   rumConfig.enableTrackAppCrash = true
   rumConfig.enableTrackAppFreeze = true
   rumConfig.errorMonitorType = .all
   rumConfig.deviceMetricsMonitorType = .all
   rumConfig.monitorFrequency = .rare
   FTSDKAgent.sharedInstance().startRum(withConfigOptions: rumConfig)

    FTLoggerConfig *loggerConfig = [[FTLoggerConfig alloc]init];
    loggerConfig.enableCustomLog = YES;
    loggerConfig.printCustomLogToConsole = YES;
    loggerConfig.enableLinkRumData = YES;
    loggerConfig.logLevelFilter = @[@(FTStatusError),@(FTStatusCritical)];
    loggerConfig.discardType = FTDiscardOldest;
    [[FTSDKAgent sharedInstance] startLoggerWithConfigOptions:loggerConfig];

    let loggerConfig = FTLoggerConfig()
    loggerConfig.enableCustomLog = true
    loggerConfig.enableLinkRumData = true
    loggerConfig.printCustomLogToConsole = true
    loggerConfig.logLevelFilter = [NSNumber(value: FTLogStatus.statusError.rawValue),NSNumber(value: FTLogStatus.statusCritical.rawValue)] // loggerConfig.logLevelFilter = [2,3]
    loggerConfig.discardType = .discardOldest
    FTSDKAgent.sharedInstance().startLogger(withConfigOptions: loggerConfig)

   FTTraceConfig *traceConfig = [[FTTraceConfig alloc]init];
   traceConfig.enableLinkRumData = YES;
     traceConfig.enableAutoTrace = YES;
   traceConfig.networkTraceType = FTNetworkTraceTypeDDtrace;
   [[FTSDKAgent sharedInstance] startTraceWithConfigOptions:traceConfig];

   let traceConfig = FTTraceConfig.init()
   traceConfig.enableLinkRumData = true
   traceConfig.enableAutoTrace = true
   FTSDKAgent.sharedInstance().startTrace(withConfigOptions: traceConfig)

/// Create View
///
/// Called before the '-startViewWithName' method, which is used to record the loading time of the page. If the loading time cannot be obtained, this method may not be called.
/// - Parameters:
///  - viewName: Current View Name
///  - loadTime: The loading time of this view（ns）
-(void)onCreateView:(NSString *)viewName loadTime:(NSNumber *)loadTime;

/// view start
///
/// - Parameters:
///  - viewName: Current View Name
-(void)startViewWithName:(NSString *)viewName;

/// view start
/// - Parameters:
///  - viewName: Current View Name
///  - property: Extra Property (optional)
-(void)startViewWithName:(NSString *)viewName property:(nullable NSDictionary *)property;

/// view stop
-(void)stopView;

/// view stop
/// - Parameter property: Extra Property (optional)
-(void)stopViewWithProperty:(nullable NSDictionary *)property;

/// Create View
///
/// Called before the '-startViewWithName' method, which is used to record the loading time of the page. If the loading time cannot be obtained, this method may not be called.
/// - Parameters:
///  - viewName: Current View Name
///  - loadTime: The loading time of this view （ns）
open func onCreateView(_ viewName: String, loadTime: NSNumber)

/// view start
///
/// - Parameters:
///  - viewName: Current View Name
open func startView(withName viewName: String)

/// view start
/// - Parameters:
///  - viewName: Current View Name
///  - property: Extra Property (optional)
open func startView(withName viewName: String, property: [AnyHashable : Any]?)

/// view stop
open func stopView() 

/// view stop
/// - Parameter property: Extra Property (optional)
open func stopView(withProperty property: [AnyHashable : Any]?)

- (void)viewDidAppear{
  [super viewDidAppear];
  // Scene 1：
  [[FTGlobalRumManager sharedManager] startViewWithName:@"TestVC"];  

  // Secne 2：  extra property
  [[FTGlobalRumManager sharedManager] startViewWithName:@"TestVC" property:@{@"custom_key":@"custom_value"}];  
}
-(void)viewDidDisappear{
  [super viewDidDisappear];
  // Scene 1：
  [[FTGlobalRumManager sharedManager] stopView];  

  // Secne 2：  extra property
  [[FTGlobalRumManager sharedManager] stopViewWithProperty:@{@"custom_key":@"custom_value"}];
}

override func viewDidAppear() {
    super.viewDidAppear()
    // Scene 1：
    FTExternalDataManager.shared().startView(withName: "TestVC")
    // Secne 2：  extra property
    FTExternalDataManager.shared().startView(withName: "TestVC",property: ["custom_key":"custom_value"])
}
override func viewDidDisappear() {
    super.viewDidDisappear()
    // Scene 1：
    FTGlobalRumManager.shared().stopView()
    // Secne 2：  extra property
    FTGlobalRumManager.shared().stopView(withProperty: ["custom_key":"custom_value"])
}

/// add action
///
/// - Parameters:
///   - actionName: action name
///   - actionType: action type
- (void)addActionName:(NSString *)actionName actionType:(NSString *)actionType;

/// add action
/// - Parameters:
///   - actionName: action name
///   - actionType: action type
///   - property: extra property (optional)
- (void)addActionName:(NSString *)actionName actionType:(NSString *)actionType property:(nullable NSDictionary *)property;

/// add action
///
/// - Parameters:
///   - actionName: action name
///   - actionType: action type
func addActionName(String, actionType: String)

/// add action
/// - Parameters:
///   - actionName: action name
///   - actionType: action type
///   - property: extra property (optional)
func addActionName(String, actionType: String, property: [AnyHashable : Any]?)

// Scene 1：
[[FTGlobalRumManager sharedManager] addActionName:@"UITableViewCell click" actionType:@"click"];
// Secne 2：  extra property
[[FTGlobalRumManager sharedManager]  addActionName:@"UITableViewCell click" actionType:@"click" property:@{@"custom_key":@"custom_value"}];

// Scene 1：
FTGlobalRumManager.shared().addActionName("custom_action", actionType: "click")
// Secne 2：  extra property
FTGlobalRumManager.shared().addActionName("custom_action", actionType: "click",property: ["custom_key":"custom_value"])

/// add error data
///
/// - Parameters:
///   - type: error type
///   - message: error message detail
///   - stack: error log content
- (void)addErrorWithType:(NSString *)type message:(NSString *)message stack:(NSString *)stack;

/// add error data
/// - Parameters:
///   - type: error type
///   - message: error message detail
///   - stack: error log content
///   - property: extra property (optional)
- (void)addErrorWithType:(NSString *)type message:(NSString *)message stack:(NSString *)stack property:(nullable NSDictionary *)property;

/// add error data
/// - Parameters:
///   - type: error type
///   - state: application running state
///   - message: error message detail
///   - stack: error log content
///   - property: extra property (optional)
- (void)addErrorWithType:(NSString *)type state:(FTAppState)state  message:(NSString *)message stack:(NSString *)stack property:(nullable NSDictionary *)property;

/// add error data
///
/// - Parameters:
///   - type: error type
///   - message: error message detail
///   - stack: error log content
func addError(withType: String, message: String, stack: String)

/// add error data
/// - Parameters:
///   - type: error type
///   - message: error message detail
///   - stack: error log content
///   - property: extra property (optional)
func addError(withType: String, message: String, stack: String, property: [AnyHashable : Any]?)

/// add error data
/// - Parameters:
///   - type: error type
///   - state: application running state
///   - message: error message detail
///   - stack: error log content
///   - property: extra property (optional)
open func addError(withType type: String, state: FTAppState, message: String, stack: String, property: [AnyHashable : Any]?)

// Scene 1：
[[FTGlobalRumManager sharedManager] addErrorWithType:@"type" message:@"message" stack:@"stack"];
// Secne 2：  extra property
[[FTGlobalRumManager sharedManager] addErrorWithType:@"ios_crash" message:@"crash_message" stack:@"crash_stack" property:@{@"custom_key":@"custom_value"}];
// Secne 3：  extra property
[[FTGlobalRumManager sharedManager] addErrorWithType:@"ios_crash" state:FTAppStateUnknown message:@"crash_message" stack:@"crash_stack" property:@{@"custom_key":@"custom_value"}];

// Scene 1：
FTGlobalRumManager.shared().addError(withType: "custom_type", message: "custom_message", stack: "custom_stack")
// Secne 2：  extra property
FTGlobalRumManager.shared().addError(withType: "custom_type", message: "custom_message", stack: "custom_stack",property: ["custom_key":"custom_value"])
// Secne 3：  extra property       
FTGlobalRumManager.shared().addError(withType: "custom_type", state: .unknown, message: "custom_message", stack: "custom_stack", property: ["custom_key":"custom_value"])

/// add long task data
///
/// - Parameters:
///   - stack: stack or log content
///   - duration: Duration, in nanoseconds.
- (void)addLongTaskWithStack:(NSString *)stack duration:(NSNumber *)duration;

/// add long task data
/// - Parameters:
///   - stack: stack or log content
///   - duration: Duration, in nanoseconds.
///   - property: extra property (optional)
- (void)addLongTaskWithStack:(NSString *)stack duration:(NSNumber *)duration property:(nullable NSDictionary *)property;

/// add long task data
///
/// - Parameters:
///   - stack: stack or log content
///   - duration: Duration, in nanoseconds.
func addLongTask(withStack: String, duration: NSNumber)

/// add long task data
/// - Parameters:
///   - stack: stack or log content
///   - duration: Duration, in nanoseconds.
///   - property: extra property (optional)
func addLongTask(withStack: String, duration: NSNumber, property: [AnyHashable : Any]?)

// Scene 1：
[[FTGlobalRumManager sharedManager] addLongTaskWithStack:@"stack string" duration:@1000000000];
// Secne 2：  extra property
[[FTGlobalRumManager sharedManager] addLongTaskWithStack:@"stack string" duration:@1000000000 property:@{@"custom_key":@"custom_value"}];

// Scene 1：
FTGlobalRumManager.shared().addLongTask(withStack: "stack string", duration: 1000000000)
// Secne 2：  extra property
FTGlobalRumManager.shared().addLongTask(withStack: "stack string", duration: 1000000000 ,property: [["custom_key":"custom_value"]])

/// resource start
///
/// - Parameters:
///   - key: resource Id ，unique every request
- (void)startResourceWithKey:(NSString *)key;

/// resource start
/// - Parameters:
///   - key: resource Id ，unique every request
///   - property: extra property
- (void)startResourceWithKey:(NSString *)key property:(nullable NSDictionary *)property;

/// resource stop
///
/// - Parameters:
///   - key: resource Id ，unique every request
- (void)stopResourceWithKey:(NSString *)key;

/// resource stop
/// - Parameters:
///   - key: resource Id ，unique every request
///   - property: extra property
- (void)stopResourceWithKey:(NSString *)key property:(nullable NSDictionary *)property;

/// append network metrics and content data
///
/// - Parameters:
///   - key: resource Id ，unique every request
///   - metrics: request performance attributes
///   - content: request data
- (void)addResourceWithKey:(NSString *)key metrics:(nullable FTResourceMetricsModel *)metrics content:(FTResourceContentModel *)content;

/// resource start
///
/// - Parameters:
///   - key: resource Id ，unique every request
open func startResource(withKey key: String)

/// resource start
/// - Parameters:
///   - key: resource Id ，unique every request
///   - property: extra property
open func startResource(withKey key: String, property: [AnyHashable : Any]?)

/// resource stop
///
/// - Parameters:
///   - key: resource Id ，unique every request
open func stopResource(withKey key: String)

/// resource stop
/// - Parameters:
///   - key: resource Id ，unique every request
///   - property: extra property
open func stopResource(withKey key: String, property: [AnyHashable : Any]?)

/// append network metrics and content data
///
/// - Parameters:
///   - key: resource Id ，unique every request
///   - metrics: request performance attributes
///   - content: request data
open func addResource(withKey key: String, metrics: FTResourceMetricsModel?, content: FTResourceContentModel)

#import "FTMacOSSDK.h"

//step 1： Before the network request starts
[[FTGlobalRumManager sharedManager] startResourceWithKey:key];

//step 2：Request completed
[[FTGlobalRumManager sharedManager] stopResourceWithKey:key];

//step 3：① Add resource data
//FTResourceContentModel 
FTResourceContentModel *content = [[FTResourceContentModel alloc]init];
content.httpMethod = request.HTTPMethod;
content.requestHeader = request.allHTTPHeaderFields;
content.responseHeader = httpResponse.allHeaderFields;
content.httpStatusCode = httpResponse.statusCode;
content.responseBody = responseBody;
//ios native
content.error = error;

//② If the performance data of the network request can be obtained
//FTResourceMetricsModel
//ios native. Get NSURLSessionTaskMetrics data, directly use the initialization method of FTResourceMetricsModel
FTResourceMetricsModel *metricsModel = [[FTResourceMetricsModel alloc]initWithTaskMetrics:metrics];

//other platforms. All time data in nanoseconds
FTResourceMetricsModel *metricsModel = [[FTResourceMetricsModel alloc]init];

// step 4：add resource： If there is no performance data, the metrics parameter is set to nil
[[FTGlobalRumManager sharedManager] addResourceWithKey:key metrics:metricsModel content:content];

import FTMacOSSDK

//step 1： Before the network request starts
FTGlobalRumManager.shared().startResource(withKey: key)

//step 2：Request completed
FTGlobalRumManager.shared().stopResource(withKey: resource.key)

//step 3：① Add resource data
let contentModel = FTResourceContentModel(request: task.currentRequest!, response: task.response as? HTTPURLResponse, data: resource.data, error: error)

//② If the performance data of the network request can be obtained
//FTResourceMetricsModel
//ios native. Get NSURLSessionTaskMetrics data, directly use the initialization method of FTResourceMetricsModel
var metricsModel:FTResourceMetricsModel?
if let metrics = resource.metrics {
   metricsModel = FTResourceMetricsModel(taskMetrics:metrics)
}
//other platforms. All time data in nanoseconds
metricsModel = FTResourceMetricsModel()
...

// step 4：add resource： If there is no performance data, the metrics parameter is set to nil
FTGlobalRumManager.shared().addResource(withKey: resource.key, metrics: metricsModel, content: contentModel)

//  FTSDKAgent.h
//  
/// Determine whether the URL is collected
/// - Parameter handler: callback，(YES collect，NO do not collect)
- (void)isIntakeUrl:(BOOL(^)(NSURL *url))handler;

//  FTSDKAgent
/// Determine whether the URL is collected
/// - Parameter handler: callback，(YES collect，NO do not collect)
open func isIntakeUrl(_ handler: @escaping (URL) -> Bool)

[[FTSDKAgent sharedInstance] isIntakeUrl:^BOOL(NSURL * _Nonnull url) {
        // Your collection judgment logic
        return YES;//return NO; (YES collect，NO do not collect)
 }];

FTSDKAgent.sharedInstance().isIntakeUrl {  url in
         //  Your collection judgment logic
       return true //return false (true collect，false do not collect)
 } 

//  FTSDKAgent.h
//  FTMacOSSDK

/// add log
/// @param content Log content, which can be a json string
/// @param status  Log Level (info、warning、error、critical、ok). 
-(void)logging:(NSString *)content status:(FTStatus)status;

/// add log
/// @param content Log content, which can be a json string
/// @param status  Log Level (info、warning、error、critical、ok). 
/// @param property Extra Property (optional)
-(void)logging:(NSString *)content status:(FTLogStatus)status property:(nullable NSDictionary *)property;

//
//  FTLogger.h
//  FTMacOSSDK

/// add info type log
/// - Parameters:
///   - content: Log content, which can be a json string
///   - property: Extra Property (optional)
-(void)info:(NSString *)content property:(nullable NSDictionary *)property;

/// add warning type log
/// - Parameters:
///   - content: Log content, which can be a json string
///   - property: Extra Property (optional)
-(void)warning:(NSString *)content property:(nullable NSDictionary *)property;

/// add error type log
/// - Parameters:
///   - content: Log content, which can be a json string
///   - property: Extra Property (optional)
-(void)error:(NSString *)content  property:(nullable NSDictionary *)property;

/// add critical type log
/// - Parameters:
///   - content: Log content, which can be a json string
///   - property: Extra Property (optional)
-(void)critical:(NSString *)content property:(nullable NSDictionary *)property;

/// add ok type log
/// - Parameters:
///   - content: Log content, which can be a json string
///   - property: Extra Property (optional)
-(void)ok:(NSString *)content property:(nullable NSDictionary *)property;

open class FTSDKAgent : NSObject {
/// add log
///
/// - Parameters:
///   - content: Log content, can be a json string
///   - status: Log Level (info、warning、error、critical、ok). 
open func logging(_ content: String, status: FTLogStatus)

/// add log
/// - Parameters:
///   - content: Log content, can be a json string
///   - status: Log Level (info、warning、error、critical、ok). 
///   - property: Extra Property (optional)
open func logging(_ content: String, status: FTLogStatus, property: [AnyHashable : Any]?)
}

open class FTLogger : NSObject, FTLoggerProtocol {}
public protocol FTLoggerProtocol : NSObjectProtocol {
/// add info type log
/// - Parameters:
///   - content: Log content, can be a json string
///   - property: Extra Property (optional)
optional func info(_ content: String, property: [AnyHashable : Any]?)

/// add warning type log
/// - Parameters:
///   - content: Log content, can be a json string
///   - property: Extra Property (optional)
optional func warning(_ content: String, property: [AnyHashable : Any]?)

/// add error type log
/// - Parameters:
///   - content:  Log content, can be a json string
///   - property: Extra Property (optional)
optional func error(_ content: String, property: [AnyHashable : Any]?)

/// add critical type log
/// - Parameters:
///   - content:  Log content, can be a json string
///   - property: Extra Property (optional)
optional func critical(_ content: String, property: [AnyHashable : Any]?)

/// add ok type log
/// - Parameters:
///   - content: Log content, can be a json string
///   - property: Extra Property (optional)
optional func ok(_ content: String, property: [AnyHashable : Any]?)
}

/// log level
typedef NS_ENUM(NSInteger, FTLogStatus) {
    /// info
    FTStatusInfo         = 0,
    /// warning
    FTStatusWarning,
    /// error
    FTStatusError,
    /// critical
    FTStatusCritical,
    /// ok
    FTStatusOk,
};

/// log level
public enum FTLogStatus : Int, @unchecked Sendable {
    /// info
    case statusInfo = 0
    /// warning
    case statusWarning = 1
    /// error
    case statusError = 2
    /// critical
    case statusCritical = 3
    /// ok
    case statusOk = 4
}

// Method 1：Use FTSDKAgent
// Note: Ensure that the SDK has been successfully initialized at the time of use, otherwise failure will be asserted in the test environment resulting in a crash.
[[FTSDKAgent sharedInstance] logging:@"test_custom" status:FTStatusInfo];

// Method 2：Use FTLogger （recommend）
// If the SDK is not initialized successfully, calling the methods in FTLogger to add custom logs will fail, but there will be no assertion failure crash.
[[FTLogger sharedInstance] info:@"test" property:@{@"custom_key":@"custom_value"}];

// Method 1：Use FTSDKAgent
// Note: Ensure that the SDK has been successfully initialized at the time of use, otherwise failure will be asserted in the test environment resulting in a crash.
FTSDKAgent.sharedInstance().logging("contentStr", status: .statusInfo, property:["custom_key":"custom_value"])

// Method 2：Use FTLogger （recommend）
// If the SDK is not initialized successfully, calling the methods in FTLogger to add custom logs will fail, but there will be no assertion failure crash.
FTLogger.shared().info("contentStr", property: ["custom_key":"custom_value"])

// FTTraceManager.h

/// Gets the request header parameters of trace
/// - Parameters:
///   - key: resource Id ，unique every request
///   - url: Request URL
/// - Returns: trace dict
- (NSDictionary *)getTraceHeaderWithKey:(NSString *)key url:(NSURL *)url;

/// Gets the request header parameters of trace
/// - Parameters:
///   - key: resource Id ，unique every request
///   - url: Request URL
/// - Returns: trace dict
open func getTraceHeader(withKey key: String, url: URL) -> [AnyHashable : Any]

NSString *key = [[NSUUID UUID]UUIDString];
NSURL *url = [NSURL URLWithString:@"http://www.baidu.com"];
//manual operation required： Get trace header before the request and add it to the request header
NSDictionary *traceHeader = [[FTTraceManager sharedInstance] getTraceHeaderWithKey:key url:url];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
if (traceHeader && traceHeader.allKeys.count>0) {
    [traceHeader enumerateKeysAndObjectsUsingBlock:^(id field, id value, BOOL * __unused stop) {
        [request setValue:value forHTTPHeaderField:field];
    }];
}
NSURLSession *session=[NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];

NSURLSessionTask *task = [session dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
   //your code
}];

[task resume];

let url:URL = NSURL.init(string: "https://www.baidu.com")! as URL
if let traceHeader = FTTraceManager.sharedInstance().getTraceHeader(withKey: NSUUID().uuidString, url: url) {
     let request = NSMutableURLRequest(url: url)
    //manual operation required： Get trace header before the request and add it to the request header
     for (a,b) in traceHeader {
         request.setValue(b as? String, forHTTPHeaderField: a as! String)
     }
     let task = URLSession.shared.dataTask(with: request as URLRequest) {  data,  response,  error in
        //your code
     }
     task.resume()
}

/// Bind user information
///
/// - Parameters:
///   - Id:  user id
- (void)bindUserWithUserID:(NSString *)userId;

/// Bind user information
///
/// - Parameters:
///   - Id:  user id
///   - userName: user name
///   - userEmailL: user email
- (void)bindUserWithUserID:(NSString *)Id userName:(nullable NSString *)userName userEmail:(nullable NSString *)userEmail;

/// Bind user information
///
/// - Parameters:
///   - Id:  user id
///   - userName: user name
///   - userEmail: user email
///   - extra: extar infomation
- (void)bindUserWithUserID:(NSString *)Id userName:(nullable NSString *)userName userEmail:(nullable NSString *)userEmail extra:(nullable NSDictionary *)extra;

/// Unbind user information
- (void)unbindUser;

/// Bind user information
///
/// - Parameters:
///   - Id:  user id
open func bindUser(withUserID userId: String)

/// Bind user information
///
/// - Parameters:
///   - Id:  user id
///   - userName: user name
///   - userEmailL: user email
open func bindUser(withUserID Id: String, userName: String?, userEmail: String?)

/// Bind user information
///
/// - Parameters:
///   - Id:  user id
///   - userName: user name
///   - userEmail: user email
///   - extra: extar infomation
open func bindUser(withUserID Id: String, userName: String?, userEmail: String?, extra: [AnyHashable : Any]?)

/// Unbind user information
open func unbindUser()

// bind user info after log in
[[FTSDKAgent sharedInstance] bindUserWithUserID:USERID];
// or
[[FTSDKAgent sharedInstance] bindUserWithUserID:USERID userName:USERNAME userEmail:USEREMAIL];
// or
[[FTSDKAgent sharedInstance] bindUserWithUserID:USERID userName:USERNAME userEmail:USEREMAIL extra:@{EXTRA_KEY:EXTRA_VALUE}];

// clear user data after log out
[[FTSDKAgent sharedInstance] unbindUser];

// bind user info after log in
FTSDKAgent.sharedInstance().bindUser(withUserID: USERID)
// or
FTSDKAgent.sharedInstance().bindUser(withUserID: USERID, userName: USERNAME, userEmail: USEREMAIL)
// or
FTSDKAgent.sharedInstance().bindUser(withUserID: USERID, userName: USERNAME, userEmail: USEREMAIL,extra:[EXTRA_KEY:EXTRA_VALUE])

// clear user data after log out
FTSDKAgent.sharedInstance().unbindUser()

/// Close the running object inside the SDK
- (void)shutDown;

/// Close the running object inside the SDK
func shutDown()

//If you dynamically change the SDK configuration, you need to close it first to avoid the generation of wrong data
[[FTSDKAgent sharedInstance] shutDown];

//If you dynamically change the SDK configuration, you need to close it first to avoid the generation of wrong data
FTSDKAgent.sharedInstance().shutDown()