Zync

object Zync : SynchronizedObject

Main entry point for the Zync SDK with integrated OfflineEngine support. This class provides access to offline-first functionality for the Zuper app.

OfflineEngine Integration: This SDK integrates the existing zuper-mobile-shared OfflineEngine to provide a unified initialization and session management experience during the phased migration to Zync. All OfflineEngine functionality remains unchanged.

Use this class for initialization and session management; access features via the managers below. For specific functionality, use the appropriate manager classes:

assets for asset data access
attachments for attachment operations
contracts for contract data access
jobs for job operations
notes for note operations
products for product data access
properties for property data access
organizations for organization data access
users for user data access
companies for company data access
customers for customer data access
serviceTasks for service task operations
tags for tag management operations
settings for user settings and preferences management
dataManager for monitoring and controlling data operations
offlineEngine for legacy OfflineEngine functionality

Properties

assets

val assets: ZyncAssetManager

Get the asset manager for handling asset operations.

attachments

val attachments: ZyncAttachmentManager

Get the attachment manager for handling attachment operations.

companies

val companies: ZyncCompanyManager

Get the company manager for handling company operations.

contracts

val contracts: ZyncContractManager

Get the contract manager for handling contract operations.

customers

val customers: ZyncCustomerManager

Get the customer manager for handling customer operations.

dataManager

val dataManager: ZyncDataManager

Get the data manager for monitoring and controlling data operations.

isOfflineEnabled

val isOfflineEnabled: Boolean

Check if offline mode is currently enabled. This is a quick synchronous check using cached state.

jobs

val jobs: ZyncJobManager

Get the job manager for handling job operations.

notes

val notes: ZyncNotesManager

Get the notes manager for handling note operations.

offlineEngine

val offlineEngine: OfflineEngine

Get the OfflineEngine instance for legacy offline functionality.

organizations

val organizations: ZyncOrganizationManager

Get the organization manager for handling organization operations.

products

val products: ZyncProductManager

Get the product manager for handling product operations.

properties

val properties: ZyncPropertyManager

Get the property manager for handling property operations.

serviceTasks

val serviceTasks: ServiceTaskManager

Get the service task manager for handling service task operations.

settings

val settings: ZyncSettingsManager

Get the settings manager for handling user settings and preferences.

Functions

addIgnoredUris

fun addIgnoredUris(ignoredUris: List<String>)

getInstance

fun getInstance(): Zync

Get the singleton instance of Zync. Will throw an exception if initialize() has not been called first.

hasValidSession

fun hasValidSession(): Boolean

Check if there is a valid user session.

initialize

fun initialize(enableLogging: Boolean, fileSystem: OfflineEngineFileSystem, internetConnectivityValidator: InternetConnectivityValidator, appInfoProvider: AppInfoProvider, enableRemoteLogging: Boolean, offlineEngineConfig: OfflineEngineConfig = OfflineEngineConfig(), httpClientConfig: HttpClientConfiguration = DefaultHttpClientConfiguration(), logWriterProvider: LogWriterProvider = DefaultLogWriterProvider()): Zync

Initialize the Zync SDK with OfflineEngine integration. This must be called before using any SDK functionality.

logout

fun logout()

Logout the current user and purge all local data.

sessionExpired

fun sessionExpired()

Handle session expiry scenarios. This should be called when the session becomes invalid (e.g., token expiry). This method preserves local data to avoid losing unsaved changes.

setSession

fun setSession(accessToken: String, userUid: String, companyUid: String, region: String, baseUrl: String, offlineEngineLogLevel: OfflineEngineLogLevel)

Set the user session information. This information will be used for all subsequent API calls.

updateRemoteConfig

fun updateRemoteConfig(configJson: String)

Update remote configuration for Zync SDK.