Interface LoadImageCollectionMessage

A command to load a WTML image collection into the frontend's registry.

Hierarchy

  • LoadImageCollectionMessage

Properties

event loadChildFolders? threadId? url

Properties

event

event: "load_image_collection"

The tag identifying this message type.

Optional loadChildFolders

loadChildFolders?: boolean

Optional, Recursively load any child folders. Defaults to False.

Optional threadId

threadId?: string

An optional, arbitrary "thread" identifier that will be included in the reply message.

The client can set this field so that it can properly associate response messages with the particular app and request that caused it. This disambiguation is needed when one client is talking to multiple apps.

url

url: string

The URL of the collection to load.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc