video-sdk/com.kaleyra.video_sdk.call.signature.model/SignDocumentUi

SignDocumentUi

data class SignDocumentUi(val id: String, val name: String, val uri: ImmutableUri, val sender: String, val creationTime: Long, val signView: ImmutableView<View>? = null, val signState: SignDocumentUi.SignStateUi) : UiState

Immutable data class representing the UI state for a document signing process.

This class holds all the necessary information to display and manage the signing of a document within the application's user interface. It is designed to be immutable to ensure data consistency and thread safety within UI rendering.

Constructors

SignDocumentUi

constructor(id: String, name: String, uri: ImmutableUri, sender: String, creationTime: Long, signView: ImmutableView<View>? = null, signState: SignDocumentUi.SignStateUi)

Types

SignStateUi

@Immutable

sealed class SignStateUi

Sealed class representing the possible states of a document signing process.

Properties

creationTime

val creationTime: Long

The timestamp (in milliseconds) indicating when the document was created or received.

val id: String

A unique identifier for the document to be signed.

name

val name: String

The user-friendly name of the document.

sender

val sender: String

The identifier (e.g., name or email) of the document's sender.

signState

val signState: SignDocumentUi.SignStateUi

The current signing state, represented by a SignStateUi object.

signView

val signView: ImmutableView<View>? = null

An optional ImmutableView containing a custom view for displaying signature-related information or controls. If null, a default signature view might be used.

uri

val uri: ImmutableUri

An ImmutableUri representing the location of the document.