Frame

A frame recorded during the Analysis.

interface Frame {
  id: string;
  parentId: string;
  loaderId: string;
  delay: string;
  navigationReason: NavigationReason; // "INITIAL" | "FORM_SUBMISSION_GET" | "FORM_SUBMISSION_POST" | "HTTP_HEADER_REFRESH" | "SCRIPT_INITIATED" | "META_TAG_REFRESH" | "PAGE_BLOCK_INTERSTITIAL" | "RELOAD" | "UNKNOWN"
  url: string;
  securityOrigin: string;
  mimeType: string;
  unreachableUrl: string;
  history: FrameHistory[];
}

Fields

Reference

Fields

id

version  : 1.0.0
stability: stable

id: string;

Id of the Frame.

parentId

version  : 1.0.0
stability: stable

parentId: string;

Parent Frame identifier.

loaderId

version  : 1.0.0
stability: stable

loaderId: string;

Identifier of the loader that loaded the Frame.

delay

version  : 1.0.0
stability: stable

delay: string;

Number of seconds in which the navigation is scheduled to start.

navigationReason

version  : 1.0.0
stability: stable

navigationReason: NavigationReason;

enum NavigationReason {
  Initial = "INITIAL",
  FormSubmissionGet = "FORM_SUBMISSION_GET",
  FormSubmissionPost = "FORM_SUBMISSION_POST",
  HttpHeaderRefresh = "HTTP_HEADER_REFRESH",
  ScriptInitiated = "SCRIPT_INITIATED",
  MetaTagRefresh = "META_TAG_REFRESH",
  PageBlockInterstitial = "PAGE_BLOCK_INTERSTITIAL",
  Reload = "RELOAD",
  Unknown = "UNKNOWN",
}

The reason that initiates the Frame navigation.

url

version  : 1.0.0
stability: stable

url: string;

Frame document's URL.

securityOrigin

version  : 1.0.0
stability: stable

securityOrigin: string;

Frame document's security origin.

mimeType

version  : 1.0.0
stability: stable

mimeType: string;

Frame document's mime type as determined by the browser.

unreachableUrl

version  : 1.0.0
stability: stable

unreachableUrl: string;

If the Frame failed to load, this will contain the URL that could not be loaded.

history

version  : 1.0.0
stability: stable

history: FrameHistory[];

interface FrameHistory {
  data: string;
  type: FrameHistoryType;
  timestamp: MonotonicTime;
  targetVersion: string;
}

enum FrameHistoryType {
  Landing = "LANDING",
  Lifecycle = "LIFECYCLE",
  Navigation = "NAVIGATION",
  Redirection = "REDIRECTION",
  ScheduledNavigation = "SCHEDULED_NAVIGATION",
  Unknown = "UNKNOWN",
}

The Frame's history records.

The history's timestamp is a baseline in seconds (see MonotonicTime).

← DetectionRecord →