HtmlrenderWebkitHeadlessProtoDocument

Next available tag: 24

Attributes

• baseUri (type: String.t, default: nil) - Document's base uri.
• charset (type: String.t, default: nil) - Document's charset.
• contentHeight (type: integer(), default: nil) -
• contentLanguage (type: String.t, default: nil) - Document's language.
• contentWidth (type: integer(), default: nil) - These fields contain the actual width and height of the document content, which may exceed the size of the rendering viewport. DEPRECATED Use rendered_content_area instead. These two fields always assume the content area begins at viewport coordinates (0,0).
• domTreeNode (type: list(GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoDOMTreeNode.t), default: nil) - A flat list of all the DOMTreeNodes in the DOM. A flat list is preferred to a tree to avoid recursion and potential stack overflows. Note that the first node in this list will always be the root node.
• frameId (type: String.t, default: nil) - A unique identifier for the frame (browser window of iframe) this document is loaded in. This identifier matches the identifiers used in the timeline data to identify frames and therefore only set if the record_timeline field of the RenderRequest message was set to true. frame_id is not supported on Chromium.
• frameName (type: String.t, default: nil) - The name of the frame (browser window of iframe) this document is loaded in. May not be set if the frame name was empty.
• javascriptTimeOfDay (type: float(), default: nil) - -------------------------------------------------------------------------- Input context. These fields are copied from RenderRequest so that Document can be a self contained protobuf. We would've liked to place them in a ## nested InputContext message but it's too late now. ## Time specified to RenderRequest.JavaScriptOptions.time_of_day, if any. ## End of input context. Output-only fields below.
• redirectHop (type: list(GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoRedirectHop.t), default: nil) - The chain of redirects (and redirect methods) used to get to the final resource for this Document. Deprecated: Use the redirect events in the render_event field instead.
• referencedResource (type: list(GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoReferencedResource.t), default: nil) - Contains a list of Resources which the renderer requested -- both those that were found and those that were not. Resources are returned in the order that they were requested.
• renderEvent (type: list(GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoRenderEvent.t), default: nil) - Different types of events which happened during rendering. All events for this document's frame are included, so for example if a confirmation dialog is created before a client redirect to this document the ConfirmationDialogEvent will still be included even though the dialog was created by a different document. See render_event.proto for the types of events which are recorded. Note that this is present regardless of whether record_timeline was set in the RenderRequest.
• renderStyle (type: list(GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoStyle.t), default: nil) - See htmlrender_webkit_headless_utils::SerializeRenderStyle() if a serialized css string is wanted.
• renderTreeNode (type: list(GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoRenderTreeNode.t), default: nil) - A flat list of all the RenderTreeNodes from the render tree. A flat list is preferred to a tree to avoid recursion and potential stack overflows. Note that the first node in this list will always be the RenderTreeNode for the #document node (aka root).
• renderTreeQualityScore (type: float(), default: nil) - DEPRECATED - This field to be removed mid-2011. If you need this, use the library directly: //google3/htmlrender/webkit_headless/snapshot_quality Indicates how good or bad the rendering is from the perspective of the render tree. This is different from snapshot_quality_score in that the quality analysis examines everything that can be rendered, not just the portion within the document's viewport. It also ignores missing resouces with fixed width/height specified in the tag. A score of 1 (100%) implies the entire document can be rendered at the best quality and a score of 0 implies the entire document is unusable.
• renderedContentArea (type: GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoBox.t, default: nil) - The bounding box which represents the whole area of rendered content, which may exceed the size of the rendering viewport. It doesn't include the body's margin.
• scrollX (type: integer(), default: nil) - Scroll offset of this document within the frame. Note that if expand_frame_to_content_height or expand_frame_to_content_width is true, this field reflects the final scroll offset after frame expansion.
• scrollY (type: integer(), default: nil) -
• snapshotQualityScore (type: float(), default: nil) - DEPRECATED - This field to be removed mid-2011. If you need this, use the library directly: //google3/htmlrender/webkit_headless/snapshot_quality Indicates how good or bad the rendered snapshot is within the rendered content area within the document's viewport. A score of 1 (100%) implies the snapshot is of best quality and a score of 0 implies the snapshot is unusable.
• title (type: String.t, default: nil) - Document's title.
• uri (type: String.t, default: nil) - Document uri is the URL that this document was fetched from. The displayed URL and base URL may be different. If this document was not fetched from any URL (e.g. iframe with no src, populated by script) uri will be "about:blank".
• viewport (type: GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoBox.t, default: nil) - The page's layout size.

Summary

Types

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoDocument{
    baseUri: String.t() | nil,
    charset: String.t() | nil,
    contentHeight: integer() | nil,
    contentLanguage: String.t() | nil,
    contentWidth: integer() | nil,
    domTreeNode:
      [
        GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoDOMTreeNode.t()
      ]
      | nil,
    frameId: String.t() | nil,
    frameName: String.t() | nil,
    javascriptTimeOfDay: float() | nil,
    redirectHop:
      [
        GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoRedirectHop.t()
      ]
      | nil,
    referencedResource:
      [
        GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoReferencedResource.t()
      ]
      | nil,
    renderEvent:
      [
        GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoRenderEvent.t()
      ]
      | nil,
    renderStyle:
      [
        GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoStyle.t()
      ]
      | nil,
    renderTreeNode:
      [
        GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoRenderTreeNode.t()
      ]
      | nil,
    renderTreeQualityScore: float() | nil,
    renderedContentArea:
      GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoBox.t()
      | nil,
    scrollX: integer() | nil,
    scrollY: integer() | nil,
    snapshotQualityScore: float() | nil,
    title: String.t() | nil,
    uri: String.t() | nil,
    viewport:
      GoogleApi.ContentWarehouse.V1.Model.HtmlrenderWebkitHeadlessProtoBox.t()
      | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()