uf-client-service-api/com.kynetics.uf.android.api

Package com.kynetics.uf.android.api

Types

Link copied to clipboard
enum AggregationPolicy : Enum<AggregationPolicy>
Content copied to clipboard

The aggregation policy of targetAttributes

Link copied to clipboard
enum ApiCommunicationVersion : Enum<ApiCommunicationVersion>
Content copied to clipboard

Enum class that represents all supported api communication versions.

Link copied to clipboard
sealed class Communication
Content copied to clipboard

Class that maps all messages that are exchanged with the com.kynetics.uf.android.UpdateFactoryService

Link copied to clipboard
data class TargetAttributesWithPolicy(val attributes: Map<String, String>, val policy: AggregationPolicy = AggregationPolicy.REPLACE)
Content copied to clipboard

A Map of target attributes with an aggregation policy

Link copied to clipboard
object UFServiceCommunicationConstants
Content copied to clipboard

This class contains all communication constants

Link copied to clipboard
data class UFServiceConfiguration(    val tenant: String,     val controllerId: String,     val retryDelay: Long,     val url: String,     val targetToken: String,     val gatewayToken: String,     isApiMode: Boolean,     isEnable: Boolean,     val isUpdateFactoryServe: Boolean,     val targetAttributes: Map<String, String>) : Serializable
Content copied to clipboard

This class represent the com.kynetics.uf.android.UpdateFactoryService's configuration

Link copied to clipboard
data class UFServiceConfigurationV2(    val tenant: String,     val controllerId: String,     val url: String,     val targetToken: String,     val gatewayToken: String,     val isApiMode: Boolean,     val isEnable: Boolean,     val isUpdateFactoryServe: Boolean,     val targetAttributes: Map<String, String> = emptyMap(),     val timeWindows: UFServiceConfigurationV2.TimeWindows = TimeWindows())
Content copied to clipboard

This class represent the com.kynetics.uf.android.UpdateFactoryService configuration

Link copied to clipboard
object UFServiceInfo
Content copied to clipboard

Utility constants related to the Update Factory Service

Link copied to clipboard
class UFServiceMessage(    val eventName: String,     val oldState: String,     val currentState: String,     val suspend: UFServiceMessage.Suspend) : Serializable
Content copied to clipboard

This class represents the service state (API version 0.1)

Functions

Link copied to clipboard
fun Message.toOutV1Message(): Communication.V1.Out
Content copied to clipboard

Transform an instance of Message to Communication.V1.Out