AttachmentsFormElement

A form element that holds one or more attachments on a feature. The AttachmentsFormElement specifies how one or more attachments can participate in the form. When present in the form, the user has the ability to edit the list of attachments specific to the form element.

Since

200.5.0

Properties

Link copied to clipboard

Returns all the current attachments. This is empty if attachments haven't yet been fetched.

Link copied to clipboard
val isEditable: StateFlow<Boolean>

True if the element is editable, False otherwise. This property can be modified by the editable expression, which can be set during Feature Form authoring.

Link copied to clipboard

A string to identify the attachment(s). When a file is attached using the form, this property sets the value of the keywords field for the attachment. When a form displays existing attachments, this property is used to query attachments with an exact match on the keywords field.

Inherited properties

Link copied to clipboard

A detailed description of the element.

Link copied to clipboard
val isVisible: StateFlow<Boolean>

The form element's visibility. This property can be modified by the visibility expression.

Link copied to clipboard

A descriptive label that appears with the element. If not supplied, a FieldFormElement is labeled with the alias property of the associated field.

Link copied to clipboard

Unknown data from the source JSON. Unknown JSON is a dictionary of values that was in the source JSON but was unparsed by the Runtime.

Link copied to clipboard

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values that are supported by web maps, but not exposed through the native Runtime API.

Functions

Link copied to clipboard
fun addAttachment(name: String, contentType: String, data: ByteArray): FormAttachment

Adds a new attachment to this AttachmentsFormElement.

Link copied to clipboard
fun addAttachmentOrNull(name: String, contentType: String, data: ByteArray): FormAttachment?

Adds a new attachment to this AttachmentsFormElement.

Link copied to clipboard

Deletes an attachment from the Feature.

Link copied to clipboard
suspend fun fetchAttachments(): Result<Unit>

Fetches the attachments from the Feature and populates AttachmentsFormElement.attachments. Attachments are not re-fetched if they have already been fetched.

Inherited functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int