Interface nsIPromptCollectionType

This interface contains various specialized prompts that the app can implement.

Hierarchy

Methods

AddRef QueryInterface Release asyncBeforeUnloadCheck confirmFolderUpload confirmRepost

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

asyncBeforeUnloadCheck

  • Puts up a dialog for the before unload prompt.

    Returns

    Promise which resolves to true if the page should be allowed to navigate away

    Parameters

    • aBrowsingContext: BrowsingContext

      The browsing context the prompt should be opened for.

    Returns any

confirmFolderUpload

  • Ask the user for confirmation to upload a selected folder.

    Returns

    true if the user confirmed the upload, false otherwise.

    Parameters

    • aBrowsingContext: BrowsingContext

      The browsing context the prompt should be opened for.

    • aDirectoryName: string

      Name of the folder that will be uploaded.

    Returns boolean

confirmRepost

  • Puts up a dialog for the confirm repost prompt.

    Returns

    true if the page should be allowed to repost data.

    Parameters

    • aBrowsingContext: BrowsingContext

      The browsing context the prompt should be opened for.

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc