ListFilesEventSchema

@Serializable
@SerialName(value = "ListFiles")
data class ListFilesEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val directory: String) : EventSchema

Lists the files directly inside directory in the client's own file storage; subdirectories and the files inside them are skipped. Each returned path is relative to the storage root — the same form GetFile and DeleteFiles take as fileName — so it can be passed straight to them. Not recursive.

incomingData consumed: not used.

Triggers fired:

  • OnSuccessEventTrigger — when the directory holds at least one file; the List<String> of file paths is passed as incomingData.

  • OnEmptyDirEventTrigger — when the directory exists but holds no files. No data is passed downstream.

  • OnFailureEventTrigger — when the directory doesn't exist (the cause is a DirNotFoundException) or the listing failed; the Throwable is passed as incomingData and the error is logged.

Constructors

Link copied to clipboard
constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, directory: String)

Properties

Link copied to clipboard
@SerialName(value = "directory")
val directory: String
Link copied to clipboard
@SerialName(value = "events")
open override val events: SerializableImmutableList<EventSchema>?

This event's own children — each declaring, via its own trigger, which of this event's outgoing triggers runs it. null when this event declares no children.

Link copied to clipboard
@SerialName(value = "id")
open override val id: String

Unique identifier — how TriggerEvent/UpdateEvents address this event by id. Defaults to a random id when omitted from the DSL.

Link copied to clipboard
@SerialName(value = "trigger")
open override val trigger: EventTrigger

The condition that must occur for this event to run — matched by structural equality (data class/data object equality) against whatever trigger value fired, never by any kind of subscription or listener registry.