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.

    Hierarchy (View Summary)

    Index

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

    "scrollGroup:onDidUpdateScrRef": ScrollGroupUpdateInfo

    Emitted when the Scripture reference for a scroll group changes.

    "webView:onDidAddWebView": OpenWebViewEvent

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

    "webView:onDidCloseWebView": CloseWebViewEvent

    Emitted when a WebView is closed.

    "webView:onDidOpenWebView": OpenWebViewEvent

    Emitted when a WebView is created.

    "webView:onDidUpdateWebView": UpdateWebViewEvent

    Emitted when a WebView is updated.