Documentation - v7.14.0
    Preparing search index...

    Interface RumPluginOnInitOptionsExperimental

    onInit plugin API options.

    interface RumPluginOnInitOptions {
        initConfiguration: RumInitConfiguration;
        publicApi: DatadogRum;
        registerAssembleEventHook: (
            this: void,
            callback: (
                params: AssembleHookParams,
            ) => "DISCARDED" | "SKIPPED" | DefaultRumEventAttributes,
        ) => { unregister: () => void };
    }
    Index
    initConfiguration publicApi registerAssembleEventHook
    initConfiguration: RumInitConfiguration
    publicApi: DatadogRum
    registerAssembleEventHook: (
        this: void,
        callback: (
            params: AssembleHookParams,
        ) => "DISCARDED" | "SKIPPED" | DefaultRumEventAttributes,
    ) => { unregister: () => void }

    Register a callback invoked when a RUM event is assembled, so plugins can enrich or override event fields before they are sent. Callbacks registered in onInit run before any event is assembled, including events buffered during the pre-start phase.

    Type Declaration

      • (
            this: void,
            callback: (
                params: AssembleHookParams,
            ) => "DISCARDED" | "SKIPPED" | DefaultRumEventAttributes,
        ): { unregister: () => void }

      • Registers a callback and returns a handle to unregister it.

        Parameters

        • this: void
        • callback: (
              params: AssembleHookParams,
          ) => "DISCARDED" | "SKIPPED" | DefaultRumEventAttributes

        Returns { unregister: () => void }

    Settings

    On This Page
    Properties