papi-dts
    Preparing search index...

    Type Alias MultiSourceNetworkEvents

    Network events emitted from multiple processes (each process emits its own local event under the same name). Declared by the platform; not extensible by extensions.

    The names listed here are the source of truth for which event names use multi-source semantics at the central registry. An event name in this type allows registration from multiple processes (each process registers once, all emitters are valid sources). Any other event name uses single-source semantics (one registrant ever).

    Subscribers do not need to know which events are multi-source — getNetworkEvent handles both kinds identically.

    See NetworkEvents for the full registry of known event names.

    type MultiSourceNetworkEvents = {
        "object:onDidCreateNetworkObject": NetworkObjectDetails;
        "object:onDidDisposeNetworkObject": string;
        "platform.onDidChangeProjects": undefined;
        "scrollGroup:onDidChangeReferenceHistory": ReferenceHistoryUpdateInfo;
        "scrollGroup:onDidUpdateScrRef": ScrollGroupUpdateInfo;
        "webView:onDidAddWebView": OpenWebViewEvent;
        "webView:onDidCloseWebView": CloseWebViewEvent;
        "webView:onDidOpenWebView": OpenWebViewEvent;
        "webView:onDidUpdateWebView": UpdateWebViewEvent;
    }

    Hierarchy (View Summary)

    Index

    Properties

    object:onDidCreateNetworkObject object:onDidDisposeNetworkObject platform.onDidChangeProjects scrollGroup:onDidChangeReferenceHistory scrollGroup:onDidUpdateScrRef webView:onDidAddWebView webView:onDidCloseWebView webView:onDidOpenWebView webView:onDidUpdateWebView

    Properties

    "object:onDidCreateNetworkObject": NetworkObjectDetails

    Emitted when a network object is created in any process. Payload includes the new object's details.

    "object:onDidDisposeNetworkObject": string

    Emitted when a network object is disposed in any process. Payload is the disposed object's ID.

    "platform.onDidChangeProjects": undefined

    Emitted when the set of available projects changes (a project is added or removed) or when a project's display metadata (name/fullName/language/languageTag/isEditable) changes. Consumers refetch cheap project metadata; there is no payload. Multi-source so any project-providing process/factory may announce it (the .NET data provider emits it today). Keep the name in sync with LocalParatextProjects.PROJECTS_CHANGED_EVENT_TYPE (C#).

    Recently added; may change as we learn how it is used.

    "scrollGroup:onDidChangeReferenceHistory": ReferenceHistoryUpdateInfo

    Emitted when a scroll group's back/forward reference history changes. Multi-source for the same reason as ['scrollGroup:onDidUpdateScrRef'].

    "scrollGroup:onDidUpdateScrRef": ScrollGroupUpdateInfo

    Emitted when the Scripture reference for a scroll group changes. Multi-source because every open window navigates its own UI and announces the result — a scroll group is app-wide, so each window must be able to tell the others where it moved to.

    "webView:onDidAddWebView": OpenWebViewEvent

    Multi-source because web views belong to the window that opened them, so every window announces its own.

    13 November 2024. Use the webView:onDidOpenWebView event instead.

    "webView:onDidCloseWebView": CloseWebViewEvent

    Emitted when a WebView is closed in any window.

    "webView:onDidOpenWebView": OpenWebViewEvent

    Emitted when a WebView is created in any window.

    "webView:onDidUpdateWebView": UpdateWebViewEvent

    Emitted when a WebView is updated in any window.

    Settings

    Member Visibility

    On This Page

    Properties