NetHopper 3.0 Document Container API

A Document Container can be used to display Web content. A Document Container is responsible for populating itself with Data Viewers based on the content returned by a transaction.

HandleURL

The Container HandleURL method tells the Container to handle the URL.

Container:HandleURL(transReqFrame, cbContext, cbMethod);

Where transReqFrame is a standard transaction request frame, cbContext is the context where you want a callback, and cbMethod is a symbol for a method in the context which contains the callback function. (See the Common API document for an explanation of the callback parameters). The callback is called with the following parameters:

transReqFrame. The actual transaction request frame generated from the initial transaction request frame.

error. Error code, if any.

Stop

This method can be used to stop a HandleURL in progress.

Container:Stop();

<TBD: Is the HandleURL callback called after Stop is called? 961021: Currently it is not.>

DispatchRawURL

The Container DispatchRawURL method tells the Container to handle the partial URL.

Container:DispatchRawURL(URLstr);

Where URLstr is a String containing a full or partial URL. If the URL is partial, it is resolved against the current base URL of the Container, if any.

Dispose

The Dispose method should be called to dispose of the container acquired from the GetBlankContainer method.

Container:Dispose();