Project Setup

Instructions for setting up the framework in the project:

1. Open the project editor, select the project, and in the “Build Settings” tab add the flag “-ObjC” to the “Other Linker Flags” setting.


2. Add the following entries to the target project's Info.plist file:
   

   
   <key>NSAppTransportSecurity</key>
   <dict>
       <key>NSExceptionDomains</key>
       <dict>
           <key>clearsale.com.br</key>
           <dict>
               <key>NSTemporaryExceptionMinimumTLSVersion</key>
               <string>TLSv1.2</string>
           </dict>
       </dict>
   </dict>
   
   <key>NSUserTrackingUsageDescription</key>
   <string>Explanation of why the user needs to grant permission.</string>
                       

   
   
3. For projects developed in Objective-C import @import CSBehavior; in the file where you want to use the framework.
   For projects developed in Swift import <CSBehavior/CSBehavior.h> in the project's bridging header.


4. To request IDFA collection permission, add the following code snippet:
   
   

   Objective-C

   
   #import <AppTrackingTransparency/AppTrackingTransparency.h>
   #import <AdSupport/AdSupport.h>
   
   if (@available(iOS 14, *)) {
       [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {
       }];
   }
                       

   
   

   Swift

   
   import AppTrackingTransparency
   
   if #available(iOS 14, *) {
       ATTrackingManager.requestTrackingAuthorization { _ in
       }
   }
                       

CSBehavior Class

CSBehavior is the class responsible for collecting information.

Constructors: this class does not have public constructors. The instance must be created through a static method.

• Static Method

• Other Methods

Security Module

The iOS SDK security module consists of a series of features aimed at protecting our products and services against attacks.

Usage

This module is available from SDK version 5.0.0. To enable it, you need to call the new method allowSecurity() before collection.

Swift

var behavior: CSBehavior = CSBehavior.getInstance("APP_KEY");
behavior.allowSecurity();
behavior.collectDeviceInformation("SESSION_ID");
        

Objective-C

CSBehavior *behavior = [[CSBehavior getInstance] @"APP_KEY" ];
[behavior allowSecurity];
[behavior collectDeviceInformation: @"SESSION_ID"];
        

Update Flow

The security module has a lifecycle that allows the application to be more secure. By using this module, there will be a requirement to always be on the latest version available, with release dates in April and October of each year.

These versions are valid for 6 months. For proper functioning, it is necessary to update before the previous version expires.

Examples

ObjC with SessionId value

CSBehavior *behavior = [CSBehavior getInstance:@"APP_KEY"];
[behavior collectDeviceInformation:@"SESSION_ID"];
            

ObjC without SessionId value

CSBehavior *behavior = [CSBehavior getInstance:@"APP_KEY"];
NSString *sessionId = [behavior generateSessionId];
[behavior collectDeviceInformation:sessionId];
            

Swift with SessionId value

var behavior: CSBehavior = CSBehavior.getInstance("APP_KEY")
behavior.collectDeviceInformation("SESSION_ID")
            

Swift without SessionId value

var behavior: CSBehavior = CSBehavior.getInstance("APP_KEY")
var sessionId: NSString = behavior.generateSessionId()
behavior.collectDeviceInformation(sessionId)
            

FAQ

Click here to access our FAQ