SENTConfig

The SENTConfig class allows you to specify your Sentiance app ID and secret when initializing the Sentiance SDK.

SENTConfig API:

baseURL

Set the platform base URL

@property (nonatomic, strong) NSString *baseURL;

appId

App ID created and managed by Sentiance's Developer Dashboard

@property (nonatomic, strong) NSString *appId;

secret

Secret token created along with App ID

@property (nonatomic, strong) NSString *secret;

launchOptions

Key value pair passed from [AppDelegate application:application didFinishLaunchingWithOptions:launchOptions]

@property (nonatomic, strong) NSDictionary *launchOptions;

registerBackgroundTaskIdentifiers

Set to YES to allow the SDK to register its own background task identifiers during initialization.

By default, this is set to NO. You should set it to YES only when initializing the SDK within your app delegate’s application:didFinishLaunchingWithOptions:launchOptions: method, as registering tasks outside of this method can cause iOS to terminate your app.

@property (nonatomic, assign) BOOL registerBackgroundTaskIdentifiers;

didReceiveSdkStatusUpdate

Callback to receive current status of SDK. Returns SENTSDKStatus

@property (nonatomic, copy) void (^didReceiveSdkStatusUpdate)(SENTSDKStatus* issue);

SENTUserLinker linking handler your own user to a Sentiance user.

@property (nonatomic, copy) SENTUserLinker link;

isTriggeredTrip

Configuration check on trip trigger availability

@property (nonatomic, assign) BOOL isTriggeredTrip;

isValidConfig

- (BOOL)isValidConfig;registerBackgroundTaskIdentifiers

Set to YES to allow the SDK to register its own background task identifiers during initialization. By default, this is set to NO. You should set it to YES only when initializing the SDK within your app delegate’s application:didFinishLaunchingWithOptions:launchOptions: method, as registering tasks outside of this method can cause iOS to terminate your app.

@property (nonatomic, assign) BOOL registerBackgroundTaskIdentifiers;

isHardEventDetectionEnabled

Check if App ID and Secret are valid

- (BOOL)isValidConfig

User Linking

Sentiance assigns to each user a unique ID. You can link your app's user to the Sentiance user using meta-user linking. The linking step involves server-to-server communication, and is triggered by the SDK via a meta-user linking callback. You can implement this callback method as follows:

SENTUserLinker userlinker = ^(NSString *installId, 
                                void (^linkSuccess)(void), 
                                void (^linkFailed)(void)) { }

SENTConfig *config = [[SENTConfig alloc] initWithAppId:APPID
                                                secret:SECRET
                                                  link:SENTUserLinker
                                         launchOptions:launchOptions];

Learn more about UserLinking here.

initWithAppId: secret: launchOptions:

SDK configuration initialization method. Returned SENTConfig object is passed to [SENTSDK initWithConfig].

- (id)initWithAppId: (NSString *) appId 
             secret: (NSString *) secret 
      launchOptions: (NSDictionary *) launchOptions;
Parameter

appId

Application key which you get from Sentiance account.

secret

Secret key which you get from Sentiance account.

launchOptions

A dictionary indicating the reason the app was launched (if any). The contents of this dictionary may be empty in situations where the user launched the app directly. For information about the possible keys in this dictionary and how to handle them, see Launch Options Keys.

SDK config intialization method with linking to customer's user id. It creates a continuous Sentiance profile across application installations and re-installations on different devices, linked together by their own user id.

- (id)initWithAppId: (NSString *) appId 
             secret: (NSString *) secret 
               link: (SENTUserLinker) link 
      launchOptions :(NSDictionary *) launchOptions;

Parameter

appId

Application key which you get from Sentiance account.

secret

Secret key which you get from Sentiance account.

link

SENTSENTUserLinkerUsersLinker type block which returns linkSuccess or linkFailed depended on how linking gone. Use InstallId to link with backend.

launchOptions

A dictionary indicating the reason the app was launched (if any). The contents of this dictionary may be empty in situations where the user launched the app directly. For information about the possible keys in this dictionary and how to handle them, see Launch Options Keys.

Last updated