WebcomConfiguration

data class WebcomConfiguration @JvmOverloads() constructor(identifier: String, platform: URL?, offlineCache: String?, websocketProtocol: WebcomConfiguration.WebsocketProtocol, pingDelayMs: Int?, pongDelayMs: Int?)

Represents the settings of a WebcomApplication instance.

WebcomConfiguration instances are generally built using the fromProperties and fromAsset methods.

Constructors

WebcomConfiguration

fun WebcomConfiguration(identifier: String, platform: URL? = null, offlineCache: String? = null, websocketProtocol: WebcomConfiguration.WebsocketProtocol = defaultWebsocketProtocol, pingDelayMs: Int? = null, pongDelayMs: Int? = null)

Builds a WebcomConfiguration instance with specific settings.

Companion

Provides with a set of methods to easily build WebcomConfiguration instances.

WebsocketProtocol

Available versions of the websocket protocol between the Webcom SDK client and the Webcom back end.

identifier

The identifier of the Webcom application.

offlineCache

The offline data to restore into the local cache when starting the Webcom application.

pingDelayMs

The delay (expressed in milliseconds) between ping requests when there is no activity on the websocket.

platform

val platform: URL? = null

The URL of the Webcom back end to use.

pongDelayMs

The maximum delay (expressed in milliseconds) for the back end to respond a ping request on the websocket.

websocketProtocol

The version of the websocket protocol to use to communicate with the Webcom back end.