DocumentManager.1.2

DocumentManager provides a way to monitor, and interact with individual documents/frames in a document tree (whether they have an ECMASCript environment or not).

Example functionality includes loading URLs in a certain frame, and enumerating all the documents in a certain Window.

ID fields

Frame IDs represent the entity that contains the document. When a new URL is loaded in a frame, the document ID will change, but the frame ID will not. This makes it possible to monitor the document history for individual frames. (Please note that the document ID will not change when a frame is reloaded).
Document ID represent the actual document. This is recreated when a new URL is loaded in its parent frame.

External ID fields

Some IDs used in this service originate (and can be used with) other services.

Window IDs are the same in all services, and can be used interchangeably everywhere. See WindowManager for window-centric commands and events.
Resource IDs in this service are compatible with resource ID fields found in ResourceManager.

GetHighlights

Get information about the currently highlighted text, resulting from a previous inline text search.

This command will fail if used on a build which does not support 'find-all' functionality, typically (non-smart) phone and TV builds.

Added in version 1.1

command GetHighlights(GetHighlightsArg)

```
required uint32 windowID = 1;
```
Get highlights in this window.
```
optional uint32 frameID = 2;
```
If set, search only in the specified frame. The frame must be part of the document tree of the previously specified window.

returns (HighlightList)

```
 repeated Highlight highlightList = 1;
```
When searching for text in a page, we often get multiple hits. This is a list of all the current hits.
```
{
```
- ```
required uint32 frameID = 1;
```
  Which frame this highlight is in.
- ```
 optional Node node = 2;
```
  The first common ancestor that contains the entire highlight.
```
{
```
  - required string tag = 1;
    
    E.g. "a", "div".
  - optional string id = 2;
    
    Present if there is an ID attribute set.
```
}
```
```
}
```

= 7;

GetPageText

Get the displayed (plain) text of a window, or document subtree. This command can fail if the connected build does not support the necessary text serialization feature.

Added in version 1.1

command GetPageText(GetPageTextArg)

```
required uint32 windowID = 1;
```
Get the text in this window.
```
optional uint32 frameID = 2;
```
If set, get the text only for the specified frame. The frame must be part of the document tree of the previously specified window.

returns (PageText)

 repeated DocumentText documentTextList = 1;

```
required uint32 frameID = 1;
```
Which frame this document sits in.
```
required uint32 documentID = 2;
```
The document that contains this text.
```
required string text = 3;
```
The (plain) text of the document.

= 8;

ListDocuments

Get the document tree for a Window, or for all Windows.

command ListDocuments(ListDocumentsArg)

```
optional uint32 windowID = 1;
```

returns (DocumentList)

```
 repeated Document documentList = 1;
```
```
{
```
- ```
required uint32 windowID = 1;
```
- ```
required uint32 frameID = 2;
```
- ```
optional uint32 documentID = 3;
```
- ```
optional uint32 parentFrameID = 4;
```
  The parent frame, present only if the frame is not the top level frame.
- ```
optional uint32 parentDocumentID = 5;
```
  Present unless this document is the top-level document in the Window.
- ```
optional string url = 6;
```
  The current URL of the document.
- ```
optional uint32 resourceID = 7;
```
  The resource used to generate this document.
- ```
optional string frameElementName = 8;
```
  The value of the name attribute of the HTMLFrameElement. If the frame does not have a name, or this document is not associated with a HTMLFrameElement, this will field will not be present.
- ```
optional string frameElementID = 9;
```
  The value of the id attribute of the HTMLFrameElement. If the frame does not have an id, or this document is not associated with a HTMLFrameElement, this will field will not be present.
```
}
```

= 1;

LoadDocument

Load a URL in a specified frame.

command LoadDocument(LoadDocumentArg)

```
required uint32 windowID = 1;
```
The window containing the frame.
```
required uint32 frameID = 2;
```
```
required string url = 3;
```

returns (Default)

= 2;

ReloadDocument

Reload the current URL for a specified frame.

command ReloadDocument(ReloadDocumentArg)

```
required uint32 windowID = 1;
```
The window containing the frame.
```
required uint32 frameID = 2;
```

returns (Default)

= 3;

SearchText

Search for a text string in a certain window, or frame.

This command will fail if used on a build which does not support 'find-all' functionality, typically (non-smart) phone and TV builds.

Added in version 1.1

command SearchText(SearchTextArg)

```
required uint32 windowID = 1;
```
Search in this window.
```
required string text = 2;
```
The text string to search for.
```
optional uint32 frameID = 3;
```
If set, search only in the specified frame. The frame must be part of the document tree of the previously specified window.

returns (HighlightList)

```
 repeated Highlight highlightList = 1;
```
When searching for text in a page, we often get multiple hits. This is a list of all the current hits.
```
{
```
- ```
required uint32 frameID = 1;
```
  Which frame this highlight is in.
- ```
 optional Node node = 2;
```
  The first common ancestor that contains the entire highlight.
```
{
```
  - required string tag = 1;
    
    E.g. "a", "div".
  - optional string id = 2;
    
    Present if there is an ID attribute set.
```
}
```
```
}
```

= 6;

OnAboutToLoadDocument

Fired when a document is about to be loaded (regardless of whether the load actually succeeds).

event OnAboutToLoadDocument returns (AboutToLoadDocument)

```
required uint32 windowID = 1;
```
```
required uint32 frameID = 2;
```
```
required uint32 resourceID = 3;
```
The resource that is about to get loaded.
```
required double time = 4;
```
Milliseconds since Unix Epoch.
```
optional uint32 parentDocumentID = 5;
```
The parent document, present only if the frame is not the top level frame.
```
optional uint32 parentFrameID = 6;
```
The parent frame, present only if the frame is not the top level frame.

= 4;

OnDocumentEvent

Fired for specific events happening during document load.

Added in version 1.2

event OnDocumentEvent returns (DocumentEvent)

Fired for specific events happening during document load.

Added in version 1.2
```
required uint32 windowID = 1;
```
```
required uint32 frameID = 2;
```
```
required uint32 documentID = 3;
```
```
required uint32 resourceID = 4;
```
The resource that was used to generate this document.
```
 required DocumentEventType eventType = 5;
```
The type of event that is being reported.
```
{
```
- Indicates the type of document event that is being reported.
  
  Added in version 1.2
- ```
DOMCONTENTLOADED_START = 0;
```
  The notification immediately before DOMContentLoaded event is handled.
- ```
DOMCONTENTLOADED_END = 1;
```
  The notification immediately after DOMContentLoaded event is handled.
- ```
LOAD_START = 2;
```
  The notification immediately before load event is handled.
- ```
LOAD_END = 3;
```
  The notification immediately after load event is handled.
- ```
UNLOAD_START = 4;
```
  The notification immediately before unload event is handled.
- ```
UNLOAD_END = 5;
```
  The notification immediately after unload event is handled.
```
}
```
```
required double time = 6;
```
Milliseconds since Unix epoch.

= 9;

OnDocumentLoaded

Fired when a document is fully loaded (after DOM event 'load' has finished).

event OnDocumentLoaded returns (DocumentLoaded)

```
required uint32 windowID = 1;
```
```
required uint32 frameID = 2;
```
```
required uint32 documentID = 3;
```

= 5;

DocumentManager1.2

Commands

Events

ID fields

External ID fields

GetHighlights

GetPageText

ListDocuments

LoadDocument

ReloadDocument

SearchText

OnAboutToLoadDocument

OnDocumentEvent

OnDocumentLoaded