data class WebcomConfiguration
Represents the settings of a WebcomApplication instance.
WebcomConfiguration instances are generally built using the fromProperties and fromAsset methods.
enum class WebsocketProtocol
Available versions of the websocket protocol between the Webcom SDK client and the Webcom back end. |
WebcomConfiguration(identifier: String, platform: URL? = null, offlineCache: String? = null, websocketProtocol: WebcomConfiguration.WebsocketProtocol = defaultWebsocketProtocol)
Builds a WebcomConfiguration instance with specific settings. |
val identifier: String
The identifier of the Webcom application. Mandatory |
|
val offlineCache: String?
The offline data to restore into the local cache when starting the Webcom application. The specified data must have been previously retrieved using DatasyncService.offlineCache. |
|
val platform: URL?
The URL of the Webcom back end to use. Optional: if not set, the production back end is used by default. |
|
val websocketProtocol: WebcomConfiguration.WebsocketProtocol
The version of the websocket protocol to use to communicate with the Webcom back end. Advanced usage: prefer using the default value. |
fun fromAsset(fileName: String): WebcomConfiguration
Builds a WebcomConfiguration instance from an Android asset fileName. |
|
fun fromProperties(properties: Properties): WebcomConfiguration
Builds a WebcomConfiguration instance from Java properties. |