Zync SDK/zync.api.sync.models/ZyncOperationUpdate

ZyncOperationUpdate

data class ZyncOperationUpdate(val uploadId: Int, val entityUid: String, val entity: ZyncEntityType, val action: ZyncActionType, val status: ZyncUploadStatus, val createdAt: String, val progress: Double? = null, val isFileOperation: Boolean = false, val errorMessage: String? = null)

Lightweight update event for real-time operation status changes.

This model is designed for efficient streaming of status updates without the overhead of full ZyncPendingUpload objects. Clients can use this to update their UI in real-time.

Constructors

ZyncOperationUpdate

constructor(uploadId: Int, entityUid: String, entity: ZyncEntityType, action: ZyncActionType, status: ZyncUploadStatus, createdAt: String, progress: Double? = null, isFileOperation: Boolean = false, errorMessage: String? = null)

Properties

action

val action: ZyncActionType

Specific action being performed on the entity.

createdAt

val createdAt: String

Timestamp of when the operation was created.

entity

val entity: ZyncEntityType

Type of entity being operated on.

entityUid

val entityUid: String

Unique identifier of the entity being operated on. Used to match updates to specific items in the UI.

errorMessage

val errorMessage: String? = null

Error message if the operation failed. Null if the operation has not failed or is still in progress.

isFileOperation

val isFileOperation: Boolean = false

Whether this operation involves actual file upload. True for CREATE_ATTACHMENT and UPDATE_ATTACHMENT_FILE operations. False for metadata operations like rename, description updates, etc.

progress

val progress: Double? = null

Upload progress as a value between 0.0 and 1.0. Null if progress is not available or not applicable.

status

val status: ZyncUploadStatus

Current status of the operation.

uploadId

val uploadId: Int

Unique identifier for the upload operation.