STREAMWIDE SDK Android 3.12.1/com.streamwide.smartms.lib.core.api/SmartMsSDK

SmartMsSDK

open class SmartMsSDK
Content copied to clipboard

The entry point of SmartMS SDK. It holds common configuration and state for the Smartms APIs

initializeApp initializes the application context. This method must be invoked at application startup otherwise a RuntimeException will be thrown

Functions

Link copied to clipboard
@Deprecated
@Nullable
open fun getAppIconBadger(): IAppIconBadgerProvider
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun getInstance(): SmartMsSDK
Content copied to clipboard
SmartMsSDK singleton getter
Link copied to clipboard
open fun getRevision(): Int
Content copied to clipboard
Gets the SDK revision.
Link copied to clipboard
@NonNull
open fun getVersion(): String
Content copied to clipboard
Gets the SDK version.
Link copied to clipboard
open fun initAppIconBadger(@NonNull appIconBadgerConfig: AppIconBadgerConfig)
Content copied to clipboard
Link copied to clipboard
open fun initCoreUpgradeCallback(@Nullable coreUpgradeCallback: ICoreUpgradeCallback)
Content copied to clipboard
initialize a callback to listen to STW Core upgrade.
Link copied to clipboard
open fun initEncryptionConfig(fileEncryptionEnabled: Boolean, dbEncryptionEnabled: Boolean)
Content copied to clipboard
Called to initialize the file and database encryption.
Link copied to clipboard
open fun initExternalLinkConfig(@NonNull externalLinkConfig: ExternalLinkConfig)
Content copied to clipboard
Link copied to clipboard
open fun initializeApp(    @NonNull applicationContext: Context,     @Nullable applicationStateListener: STWApplicationStateListener,     @Nullable serviceConfig: STWServiceConfig)
Content copied to clipboard
Initializes the application context &all required callbacks.
@Deprecated
open fun initMyBusinessUploadServiceNotificationConfig(@NonNull myBusinessUploadServiceNotificationConfig: MyBusinessUploadServiceNotificationConfig)
Content copied to clipboard
Initialize the configuration related to the upload attachment service config
Link copied to clipboard
open fun initPushConfig(@NonNull pushConfig: PushConfig)
Content copied to clipboard
Link copied to clipboard
open fun isApplicationActive(): Boolean
Content copied to clipboard
When click on switch button, the Agnet Communicator module will work to disable this application and put another application in front.
Link copied to clipboard
@Deprecated
open fun isDatabaseUpgrading(): Boolean
Content copied to clipboard
either the database is upgrading or not
Link copied to clipboard
open fun isSDKUpgrading(): Boolean
Content copied to clipboard
either the database is upgrading or not
Link copied to clipboard
@Deprecated
open fun listenToDatabaseUpgrade(@NonNull iDatabaseUpgradeCallback: IDatabaseUpgradeCallback)
Content copied to clipboard
initialize a callback to listen to database upgrade.
Link copied to clipboard
open fun listenToSDKMigration(@Nullable iMigrationCallback: IMigrationCallback)
Content copied to clipboard
initialize a callback to listen to the SDK migration/update/upgrading.
Link copied to clipboard
open fun registerMainServiceListener(@NonNull listener: STWServiceListener)
Content copied to clipboard
Register the listener to handle main service events.
Link copied to clipboard
open fun setApplicationActive(isApplicationActive: Boolean)
Content copied to clipboard
Link copied to clipboard
open fun setupMyBusinessConfiguration(@NonNull myBusinessConfiguration: MyBusinessConfiguration)
Content copied to clipboard
Setup the configuration related to My business module
Link copied to clipboard
open fun unregisterServiceListener(@NonNull listener: STWServiceListener)
Content copied to clipboard
Unregister the service event listener