papi-dts
    Preparing search index...

    Interface IScrollGroupInternalServiceExperimental

    Scroll group operations that exist for the platform's own cache-keeping rather than for consumers. They are deliberately kept off IScrollGroupService, so papi.scrollGroups does not offer them.

    That is the whole guarantee, and it is a discoverability one rather than a privacy one: these ride on the same network object as IScrollGroupRemoteService under the same name, so any process that resolves the object itself can call them. That reachability is why they are @experimental on both surfaces (TSDoc here, x-experimental in the registration's OpenRPC document) rather than pretending to be private.

    interface IScrollGroupInternalService {
        getScrollGroupSnapshot(): Promise<ScrollGroupSnapshot>;
        migrateStoredScrollGroupState(
            state: PersistedScrollGroupState,
        ): Promise<boolean>;
    }
    Index

    Methods

    • Experimental

      Get every scroll group's current reference, source project, and reference history at once, so a process keeping a local cache can (re)seed it in one round trip rather than one per group.

      Returns Promise<ScrollGroupSnapshot>

      Copy of the whole scroll group state, safe to keep

    • Experimental

      Hand over scroll group state persisted somewhere the host cannot read, so the host can adopt it into its own store. Idempotent: the first offer to be adopted wins and every later one is refused, so several callers offering their own copies cannot interleave into a mixture of them.

      Resolving is terminal for the caller either way: true means the state now lives in the host's store, false means the host already has state that beats the offer. In both cases the caller's copy is dead and should be discarded. A rejection means neither — the offer can be made again.

      Parameters

      Returns Promise<boolean>

      true if the offer was adopted, false if it was refused