Interface nsIScriptChannelType

An interface representing a channel which will have to execute some sort of program provided via its URI to compute the data it should return.

If a channel implements this interface, the execution of the program in question will be restricted in the following ways:

  • If the channel does not have an owner principal, the program will not be executed at all, no matter what. This is necessary because in this circumstance we have no way to tell whether script execution is allowed at all for the originating security context of this channel.
  • If the channel has an owner principal, how it is executed is controlled by this interface. However if the owner principal does not subsume the principal of the environment in which the program is to be executed the execution will be forced to happen in a sandbox.

Hierarchy

Properties

executeAsync executionPolicy isDocumentLoad

Methods

AddRef QueryInterface Release

Properties

executeAsync

executeAsync: boolean

Control whether the program should be executed synchronosly when the channel's AsyncOpen method is called or whether it should be executed asynchronously. In both cases, any data that the channel returns will be returned asynchronously; the only thing this property affects is when the program executes.

The default value of this property is TRUE.

Setting this property after asyncOpen has been called on the channel has no effect.

executionPolicy

executionPolicy: number

Whether and how the program represented by this channel is to be executed. The default value if this property has never been set on this channel MUST be either EXECUTE_IN_SANDBOX or NO_EXECUTION.

Throws

NS_ERROR_INVALID_ARG when set to an unrecognized value.

Readonly isDocumentLoad

isDocumentLoad: boolean

Check whether this script channel is a document load. This is needed because script channels can lie about their LOAD_DOCUMENT_URI flag until they have run the script.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc