User-level settings

This guide describes user-level configuration APIs, including listening for settings sync events.

Listen for user settings sync

After connecting successfully, the SDK pulls the current user's settings from the server. Register an NCUserSettingsHandler to receive the sync completion callback.

Register the handler

Swift

swift

import NexconnChatSDK
final class UserSettingsSyncHandler: NSObject, UserSettingsHandler {}
let settingsHandler = UserSettingsSyncHandler()
NCEngine.addUserSettingsHandler(identifier: "USER_SETTINGS_HANDLER", handler: settingsHandler)
// Remove when no longer needed
NCEngine.removeUserSettingsHandler(forIdentifier: "USER_SETTINGS_HANDLER")

Objective-C

Objective C

[NCEngine addUserSettingsHandlerWithIdentifier:@"USER_SETTINGS_HANDLER" handler:self];

// Remove when no longer needed
[NCEngine removeUserSettingsHandlerForIdentifier:@"USER_SETTINGS_HANDLER"];

Implement the callback

The onUserSettingsSyncCompleted: callback in NCUserSettingsHandler fires when sync is complete:

Swift

swift

import NexconnChatSDK
func onUserSettingsSyncCompleted(_ event: UserSettingsSyncCompletedEvent) {
    if event.error == nil {
        print("User settings synced successfully.")
    } else {
        print("User settings sync failed: \(event.error!.localizedDescription)")
    }
}

Objective-C

Objective C

- (void)onUserSettingsSyncCompleted:(NCUserSettingsSyncCompletedEvent *)event {
    if (event.error == nil) {
        NSLog(@"User settings synced successfully.");
    } else {
        NSLog(@"User settings sync failed: %@", event.error);
    }
}