data class WebcomConfiguration
Represents the settings of a WebcomApplication instance.
WebcomConfiguration instances are genrally 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, isPersistent: Boolean = defaultIsPersistent.toBoolean(), websocketProtocol: WebcomConfiguration.WebsocketProtocol = WebsocketProtocol.valueOf(defaultWebsocketProtocol))
Builds a WebcomConfiguration instance with specific settings. |
val identifier: String
The identifier of the Webcom application. Mandatory |
|
val isPersistent: Boolean
Indicates whether the Webcom application can restore and persist its data from or to the
local storage of the device. Optional: defaults to |
|
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(name: String): WebcomConfiguration
Builds a WebcomConfiguration instance from an Android asset file named name. |
|
fun fromProperties(properties: Properties): WebcomConfiguration
Builds a WebcomConfiguration instance from Java properties. |