Preload Domain
Methods
Events
- Preload.prefetchStatusUpdated
- Preload.preloadEnabledStateUpdated
- Preload.preloadingAttemptSourcesUpdated
- Preload.prerenderStatusUpdated
- Preload.ruleSetRemoved
- Preload.ruleSetUpdated
Types
- Preload.PrefetchStatus
- Preload.PreloadingAttemptKey
- Preload.PreloadingAttemptSource
- Preload.PreloadingStatus
- Preload.PreloadPipelineId
- Preload.PrerenderFinalStatus
- Preload.PrerenderMismatchedHeaders
- Preload.RuleSet
- Preload.RuleSetErrorType
- Preload.RuleSetId
- Preload.SpeculationAction
- Preload.SpeculationTargetHint
Methods
Events
Preload.prefetchStatusUpdated #
Fired when a prefetch attempt is updated.
Parameters
pipelineId initiatingFrameId The frame id of the frame initiating prefetch.
prefetchUrl stringstatus prefetchStatus requestId Preload.preloadEnabledStateUpdated #
Fired when a preload enabled state is updated.
Parameters
disabledByPreference booleandisabledByDataSaver booleandisabledByBatterySaver booleandisabledByHoldbackPrefetchSpeculationRules booleandisabledByHoldbackPrerenderSpeculationRules booleanPreload.preloadingAttemptSourcesUpdated #
Send a list of sources for all preloading attempts in a document.
Parameters
loaderId preloadingAttemptSources array[ PreloadingAttemptSource ]Preload.prerenderStatusUpdated #
Fired when a prerender attempt is updated.
Parameters
pipelineId status prerenderStatusOptional
disallowedMojoInterfaceOptional
stringThis is used to give users more information about the name of Mojo interface that is incompatible with prerender and has caused the cancellation of the attempt.
mismatchedHeadersOptional
array[ PrerenderMismatchedHeaders ]Types
Preload.PrefetchStatus #
TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and filter out the ones that aren't necessary to the developers.
Type: string
Allowed values: PrefetchAllowed, PrefetchFailedIneligibleRedirect, PrefetchFailedInvalidRedirect, PrefetchFailedMIMENotSupported, PrefetchFailedNetError, PrefetchFailedNon2XX, PrefetchEvictedAfterBrowsingDataRemoved, PrefetchEvictedAfterCandidateRemoved, PrefetchEvictedForNewerPrefetch, PrefetchHeldback, PrefetchIneligibleRetryAfter, PrefetchIsPrivacyDecoy, PrefetchIsStale, PrefetchNotEligibleBrowserContextOffTheRecord, PrefetchNotEligibleDataSaverEnabled, PrefetchNotEligibleExistingProxy, PrefetchNotEligibleHostIsNonUnique, PrefetchNotEligibleNonDefaultStoragePartition, PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy, PrefetchNotEligibleSchemeIsNotHttps, PrefetchNotEligibleUserHasCookies, PrefetchNotEligibleUserHasServiceWorker, PrefetchNotEligibleUserHasServiceWorkerNoFetchHandler, PrefetchNotEligibleRedirectFromServiceWorker, PrefetchNotEligibleRedirectToServiceWorker, PrefetchNotEligibleBatterySaverEnabled, PrefetchNotEligiblePreloadingDisabled, PrefetchNotFinishedInTime, PrefetchNotStarted, PrefetchNotUsedCookiesChanged, PrefetchProxyNotAvailable, PrefetchResponseUsed, PrefetchSuccessfulButNotUsed, PrefetchNotUsedProbeFailed
Preload.PreloadingAttemptKey #
A key that identifies a preloading attempt.
The url used is the url specified by the trigger (i.e. the initial URL), and not the final url that is navigated to. For example, prerendering allows same-origin main frame navigations during the attempt, but the attempt is still keyed with the initial URL.
Type: object
Properties
loaderId action url stringtargetHintOptional
Preload.PreloadingAttemptSource #
Lists sources for a preloading attempt, specifically the ids of rule sets that had a speculation rule that triggered the attempt, and the BackendNodeIds of or elements that triggered the attempt (in the case of attempts triggered by a document rule). It is possible for multiple rule sets and links to trigger a single attempt.
Type: object
Properties
ruleSetIds array[ RuleSetId ]nodeIds array[ DOM.BackendNodeId ]Preload.PreloadingStatus #
Preloading status values, see also PreloadingTriggeringOutcome. This status is shared by prefetchStatusUpdated and prerenderStatusUpdated.
Type: string
Allowed values: Pending, Running, Ready, Success, Failure, NotSupported
Preload.PreloadPipelineId #
Chrome manages different types of preloads together using a concept of preloading pipeline. For example, if a site uses a SpeculationRules for prerender, Chrome first starts a prefetch and then upgrades it to prerender.
CDP events for them are emitted separately but they share
PreloadPipelineId.
Type: string
Preload.PrerenderFinalStatus #
List of FinalStatus reasons for Prerender2.
Type: string
Allowed values: Activated, Destroyed, LowEndDevice, InvalidSchemeRedirect, InvalidSchemeNavigation, NavigationRequestBlockedByCsp, MojoBinderPolicy, RendererProcessCrashed, RendererProcessKilled, Download, TriggerDestroyed, NavigationNotCommitted, NavigationBadHttpStatus, ClientCertRequested, NavigationRequestNetworkError, CancelAllHostsForTesting, DidFailLoad, Stop, SslCertificateError, LoginAuthRequested, UaChangeRequiresReload, BlockedByClient, AudioOutputDeviceRequested, MixedContent, TriggerBackgrounded, MemoryLimitExceeded, DataSaverEnabled, TriggerUrlHasEffectiveUrl, ActivatedBeforeStarted, InactivePageRestriction, StartFailed, TimeoutBackgrounded, CrossSiteRedirectInInitialNavigation, CrossSiteNavigationInInitialNavigation, SameSiteCrossOriginRedirectNotOptInInInitialNavigation, SameSiteCrossOriginNavigationNotOptInInInitialNavigation, ActivationNavigationParameterMismatch, ActivatedInBackground, EmbedderHostDisallowed, ActivationNavigationDestroyedBeforeSuccess, TabClosedByUserGesture, TabClosedWithoutUserGesture, PrimaryMainFrameRendererProcessCrashed, PrimaryMainFrameRendererProcessKilled, ActivationFramePolicyNotCompatible, PreloadingDisabled, BatterySaverEnabled, ActivatedDuringMainFrameNavigation, PreloadingUnsupportedByWebContents, CrossSiteRedirectInMainFrameNavigation, CrossSiteNavigationInMainFrameNavigation, SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation, SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation, MemoryPressureOnTrigger, MemoryPressureAfterTriggered, PrerenderingDisabledByDevTools, SpeculationRuleRemoved, ActivatedWithAuxiliaryBrowsingContexts, MaxNumOfRunningEagerPrerendersExceeded, MaxNumOfRunningNonEagerPrerendersExceeded, MaxNumOfRunningEmbedderPrerendersExceeded, PrerenderingUrlHasEffectiveUrl, RedirectedPrerenderingUrlHasEffectiveUrl, ActivationUrlHasEffectiveUrl, JavaScriptInterfaceAdded, JavaScriptInterfaceRemoved, AllPrerenderingCanceled, WindowClosed, SlowNetwork, OtherPrerenderedPageActivated, V8OptimizerDisabled, PrerenderFailedDuringPrefetch, BrowsingDataRemoved, PrerenderHostReused
Preload.PrerenderMismatchedHeaders #
Information of headers to be displayed when the header mismatch occurred.
Type: object
Properties
headerName stringinitialValueOptional
stringactivationValueOptional
stringPreload.RuleSet #
Corresponds to SpeculationRuleSet
Type: object
Properties
id loaderId Identifies a document which the rule set is associated with.
sourceText stringSource text of JSON representing the rule set. If it comes from
<script> tag, it is the textContent of the node. Note that it is
a JSON for valid case.
See also:
- https://wicg.github.io/nav-speculation/speculation-rules.html
- https://github.com/WICG/nav-speculation/blob/main/triggers.md
backendNodeIdOptional
A speculation rule set is either added through an inline
<script> tag or through an external resource via the
'Speculation-Rules' HTTP header. For the first case, we include
the BackendNodeId of the relevant <script> tag. For the second
case, we include the external URL where the rule set was loaded
from, and also RequestId if Network domain is enabled.
See also:
- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script
- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header
urlOptional
stringrequestIdOptional
errorTypeOptional
Error information
errorMessage is null iff errorType is null.
errorMessageOptional
stringTODO(https://crbug.com/1425354): Replace this property with structured error.
tagOptional
stringFor more details, see: https://github.com/WICG/nav-speculation/blob/main/speculation-rules-tags.md
Preload.RuleSetErrorType #
Type: string
Allowed values: SourceIsNotJsonObject, InvalidRulesSkipped, InvalidRulesetLevelTag
Preload.SpeculationAction #
The type of preloading attempted. It corresponds to mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it isn't being used by clients).
Type: string
Allowed values: Prefetch, Prerender
Preload.SpeculationTargetHint #
Corresponds to mojom::SpeculationTargetHint. See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints
Type: string
Allowed values: Blank, Self