Search

Search something to see results

SoftNavigationParameters

Metainformation needed for initializing a new Soft Navigation.

interface SoftNavigationParameters {
    navigationType?: NavigationTypeIndex;
    onCollapse?: (unsentTracking: TrackingObject) => TrackingObject;
    provisional?: Promise<void>;
    softRenderDuration?: number;
    softResourcesDuration?: number;
    timestamp?: number;
}

Index

Properties

Types.SoftNavigationParameters.navigationTypeTypes.SoftNavigationParameters.onCollapseTypes.SoftNavigationParameters.provisionalTypes.SoftNavigationParameters.softRenderDurationTypes.SoftNavigationParameters.softResourcesDurationTypes.SoftNavigationParameters.timestamp

Properties

navigationType?: NavigationTypeIndex

Navigation Type of the Soft Navigation (e.g. regular soft navigation or back-forward soft navigation).

onCollapse?: (unsentTracking: TrackingObject) => TrackingObject

Optional mapping function to manipulate unsent tracking of a discarded Soft PI. This is needed if some information we collected should appear differently when being collapsed into the previous PI. E.g. we use this to enlist a url into the historyReplaceList property instead of overriding the original url in our HistoryApiPlugin.

provisional?: Promise<void>

If no final decision on whether we want to start a full page impression is possible we start a provisional navigation.

Once then decision is finalized the promise can be resolved to promote the provisional PI to a full PI. If the PI should not be promoted the promise can be rejected or alternatively a new full PI can be triggered to discard any open provisional PI. All unsent tracking data will be collapsed into the previous full Page Impression.

softRenderDuration?: number

Time it took to display the changes of the Soft Navigation.

softResourcesDuration?: number

Time it took to load all resources regarding the Soft Navigation.

timestamp?: number

Start timestamp of the Soft Navigation.