commonMain.dk.cachet.carp.common.application.devices.DefaultDeviceRegistration.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of carp.common

Helper classes and base types relied upon by all subsystems. This library does not contain any domain logic.

The newest version!

package dk.cachet.carp.common.application.devices

import dk.cachet.carp.common.application.UUID
import dk.cachet.carp.common.infrastructure.serialization.NotSerializable
import kotlinx.serialization.*
import kotlin.js.JsExport


/**
 * A concrete [DeviceRegistration] which solely implements the base properties and nothing else.
 *
 * The base class can't be made concrete since this would prevent being able to serialize extending types (constructors may not contain parameters which are not properties).
 */
@Serializable
@JsExport
data class DefaultDeviceRegistration(
    @Required
    override val deviceDisplayName: String? = null,
    @Required
    override val deviceId: String = UUID.randomUUID().toString()
) : DeviceRegistration()


/**
 * A default device registration builder which solely involves assigning a display name and unique ID to the device.
 * By default, a unique ID (UUID) is generated.
 */
@Suppress( "SERIALIZER_TYPE_INCOMPATIBLE" )
@Serializable( with = NotSerializable::class )
@JsExport
class DefaultDeviceRegistrationBuilder : DeviceRegistrationBuilder()
{
    /**
     * Override the default assigned UUID which has been set as device ID.
     * Make sure this ID is unique for the type of device you are creating a registration for.
     */
    var deviceId: String = UUID.randomUUID().toString()

    override fun build(): DefaultDeviceRegistration = DefaultDeviceRegistration( deviceDisplayName, deviceId )
}