Interface nsIWebBrowserPersistWriteCompletionType

Asynchronous callback for when nsIWebBrowserPersistDocument is finished serializing the document's DOM.

Hierarchy

Methods

AddRef QueryInterface Release onFinish

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

onFinish

  • Indicates that serialization is finished.

    Parameters

    • aDocument: nsIWebBrowserPersistDocument

      The document that was being serialized.

    • aStream: nsIOutputStream

      The stream that was being written to. If it needs to be closed, the callback must do that; the serialization process leaves it open.

    • aContentType: string

      The content type with which the document was actually serialized; this may be useful to set metadata on the result, or if uploading it.

    • aStatus: number

      Indicates whether serialization encountered an error.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc