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;
    }

    Hierarchy (View Summary)

    Index

    Properties

    object:onDidCreateNetworkObject object:onDidDisposeNetworkObject platform.onDidChangeProjects

    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.

    Settings

    Member Visibility

    On This Page

    Properties