SDK lifecycle

Set Synerise delegate

This method sets an object for Synerise delegate methods.

Declared In:
Headers/SNRSynerise.h

Related To:
SyneriseDelegate

Class:
Synerise

Declaration:

static func setDelegate(_ delegate: SyneriseDelegate)

+ (void)setDelegate:(SNRSyneriseDelegate *)delegate

Discussion:
Learn more about the methods and the purpose of this listener here.

Initialization

This method initializes Synerise.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func initialize(clientApiKey: String) -> Void

+ (void)initializeWithClientApiKey:(NSString *)clientApiKey

Parameters:

Return Value:
No value is returned.

Example:

let clientApiKey = "YOUR_CLIENT_API_KEY"
Synerise.initialize(clientApiKey: clientApiKey)

static NSString *clientApiKey = @"YOUR_CLIENT_API_KEY";
[SNRSynerise initializeWithClientApiKey:clientApiKey];

Initialize with custom environment

This method initializes Synerise SDK with custom environment settings.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func initialize(clientApiKey: String, baseUrl: String?) -> Void

+ (void)initializeWithClientApiKey:(NSString *)clientApiKey andBaseUrl:(nullable NSString *)baseUrl

Parameters:

Return Value:
No value is returned.

Example:

let clientApiKey = "YOUR_CLIENT_API_KEY"
let apiBaseUrl = "YOUR_API_BASE_URL"
Synerise.initialize(clientApiKey: clientApiKey, baseUrl: apiBaseUrl)

static NSString *clientApiKey = @"YOUR_CLIENT_API_KEY";
static NSString *apiBaseUrl = @"YOUR_API_BASE_URL";
[SNRSynerise initializeWithClientApiKey:clientApiKey andBaseUrl:apiBaseUrl];

Change Profile API Key dynamically

This method changes a Profile (formerly Client) API key dynamically.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func changeClientApiKey(_ clientApiKey: String) -> Void

+ (void)changeClientApiKey:(nonnull NSString *)clientApiKey

Parameters:

Return Value:
No value is returned.

Change Profile API Key dynamically with config

This method changes a Profile (formerly Client) API key dynamically, with additional parameters. It can include a salt for Simple Authentication requests.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func changeClientApiKey(_ clientApiKey: String, config: SNRInitializationConfig?) -> Void

(void)changeClientApiKey:(NSString *)clientApiKey config:(nullable SNRInitializationConfig *)config;

Parameters:

Return Value:
No value is returned.

Set Request Validation Salt

This method sets the salt string for request validation.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func setRequestValidationSalt(_: String?) -> Void

+ (void)setRequestValidationSalt:(nullable NSString *)string

Parameters:

Return Value:
No value is returned.

Set up host application type

This method sets the Synerise SDK host application type.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func setHostApplicationType(_ type: HostApplicationType) -> Void

+ (void)setHostApplicationType:(SNRHostApplicationType)type

Parameters:

Return Value:
No value is returned.

Set host application SDK plugin version

This method sets the Synerise SDK plugin version.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func setHostApplicationSDKPluginVersion(_ version: String) -> Void

+ (void)setHostApplicationSDKPluginVersion:(NSString *)version

Parameters:

Return Value:
No value is returned.

Enable Debug Mode

This method enables or disables console logs from Synerise SDK.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func setDebugModeEnabled(_: Bool) -> Void

+ (void)setDebugModeEnabled:(BOOL)enabled;

Parameters:

Return Value:
No value is returned.

Enable Crash Handling

This method enables or disables crash handling by Synerise SDK.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func setCrashHandlingEnabled(_: Bool) -> Void

+ (void)setCrashHandlingEnabled:(BOOL)enabled

Parameters:

Return Value:
No value is returned.

Set Background Task identifiers

This method sets identifiers for Background Tasks processing.

Declared In:
Headers/SNRSynerise.h

Class:
Synerise

Declaration:

static func setBackgroundTaskIdentifiers(_: [String]) -> Void

+ (void)setBackgroundTaskIdentifiers:(NSArray<NSString *> *)identifiers

Parameters:

Return Value:
No value is returned.