hosanna-ui-docs - v0.9.0
    Preparing search index...

    WebAsyncManagerTask is a specialized SGTask for managing async commands and events on the web platform.

    • Integrates with AsyncManager to handle async command execution and event dispatching.
    • Observes the 'control' field to start the async manager when the task is set to run.
    • Exposes 'command' and 'event' fields for communication with the async system.

    Hierarchy

    • WebSGTask
      • WebAsyncManagerTask

    Indexable

    • [key: string]: any
    Index

    Constructors

    Properties

    _hid: string

    Internal ID used to identify nodes in debugger views. DO NOT USE THIS ID FOR ANYTHING ELSE.

    _oid: undefined = undefined

    Internal object ID (not used on some platforms).

    The AsyncManager instance responsible for managing async commands and events.

    boundView: any

    The bound view associated with the node (if any).

    change: undefined = undefined

    Change handler for the node (not implemented).

    children: ISGNNode[] = []

    The child nodes of this node.

    command?: IAsyncCommand<unknown>

    The async command to be processed by the manager.

    control?: TaskControl

    Task control state

    div: undefined | HTMLDivElement

    The HTML div element associated with the node (if applicable).

    event?: IAsyncEvent<any>

    The async event to be sent or received by the manager.

    focusable: boolean = true

    Indicates whether the node is focusable.

    focusedChild: undefined = undefined

    The currently focused child node (if any).

    functionName?: string

    Function name to execute

    observers: Record<string, FieldObserver[]> = {}

    A record of field observers, keyed by field names.

    state?: string

    Current state

    Accessors

    Methods

    • Adds an observer to a specific field.

      Parameters

      • fieldName: string

        The name of the field to observe.

      • portOrString: string | Function | ISGROMessagePort

        The message port or function to associate with the observer.

      • OptionalinfoFields: string[]

        Optional fields to observe for additional information.

      Returns boolean

      true if the observer was added successfully, otherwise false.