papi-dts
    Preparing search index...

    Interface NetworkEvents

    Mapping of network event names to their payload types. Extensions augment this to declare their own events. Inherits the platform's multi-source events from MultiSourceNetworkEvents automatically.

    To declare a new event for use with createNetworkEventEmitterAsync:

    declare module 'papi-shared-types' {
      export interface NetworkEvents {
        'myExt.somethingHappened': { foo: string };
      }
    }

    Mark a single event as experimental by adding an @experimental JSDoc tag in a doc comment directly above its entry.

    interface NetworkEvents {
        "object:onDidCreateNetworkObject": NetworkObjectDetails;
        "object:onDidDisposeNetworkObject": string;
        "platform.onDidAppWindowInput": AppWindowInputEvent;
        "platform.onDidChangeProjects": undefined;
        "platform.onDidReloadExtensions": boolean;
        "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.onDidAppWindowInput platform.onDidChangeProjects platform.onDidReloadExtensions 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.onDidAppWindowInput": AppWindowInputEvent

    Emitted by the main process for every mouse-down and every Escape key-down anywhere in the app window, including inside WebView iframes. Transient overlays (context menus, command palettes, dismissable popovers) dismiss on it.

    "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.

    "platform.onDidReloadExtensions": boolean

    Emitted when extensions finish reloading. true if reload succeeded, false if it failed.

    "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