BulkEvent

A committed bulk action, with the same v2 envelope as its single changelog.

Inheritors

Properties

Link copied to clipboard
open override val change: Change

Polymorphic payload for the specific change.

Link copied to clipboard

The applied v2 changelog; the event also exposes its fields directly.

Link copied to clipboard
open override val createdOn: Long

Epoch millis when the change was created.

Link copied to clipboard
open override val fieldId: String

Target field id.

Link copied to clipboard
open override val fieldIdentifier: String

Target field identifier.

Link copied to clipboard
open override val fieldPositionId: String

Layout position id for the field instance.

Link copied to clipboard
open override val fileId: String

File id containing the page.

Link copied to clipboard
open override val id: String

Document id.

Link copied to clipboard
open override val identifier: String

External document identifier.

Link copied to clipboard
open override val multi: Boolean?

When applicable, whether the underlying file component supports multiple selections.

Link copied to clipboard
open override val page: Page

The page containing the component.

Link copied to clipboard
open override val pageId: String

Page id containing the target field.

Link copied to clipboard
open override val sdk: String

SDK version string producing the change.

Link copied to clipboard
open override val source: Nothing?

The originating editor (if available for cell events).

Link copied to clipboard
open override val target: String

Change target identifier used by handlers.

Link copied to clipboard
open override val type: String
Link copied to clipboard
open override val v: Int

Schema version for the change envelope.

Link copied to clipboard
open override val view: String?

View type (e.g., "mobile") for view-specific changes.

Link copied to clipboard
open override val viewId: String?

View id for view-specific changes.

Functions

Link copied to clipboard
open override fun toJsonObject(): JsonObject
Link copied to clipboard
open override fun toJsonString(): String
Link copied to clipboard
open override fun toMap(): MutableMap<String, Any?>
Link copied to clipboard

Serializes the standard bulk changelog envelope with readable indentation.