Interface nsIJumpListBuilderType

Hierarchy

Properties

available isListCommitted maxListItems

Methods

AddRef QueryInterface Release abortListBuild addListToBuild commitListBuild deleteActiveList initListBuild setAppUserModelID

Properties

Readonly available

available: number

Indicates whether jump list taskbar features are supported by the current host.

Readonly isListCommitted

isListCommitted: boolean

JumpList management

Throw

NS_ERROR_NOT_AVAILABLE on all calls if taskbar functionality is not supported by the operating system. Indicates if a commit has already occurred in this session.

Readonly maxListItems

maxListItems: number

The maximum number of jump list items the current desktop can support.

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

abortListBuild

  • Aborts and clears the current jump list build.

    Returns void

addListToBuild

  • Adds a list and if required, a set of items for the list.

    Returns

    true if the operation completed successfully.

    Throw

    NS_ERROR_INVALID_ARG if incorrect parameters are passed for a particular category or item type.

    Throw

    NS_ERROR_ILLEGAL_VALUE if an item is added that was removed since the last commit.

    Throw

    NS_ERROR_UNEXPECTED on internal errors.

    Parameters

    • aCatType: number

      The type of list to add.

    • items: nsIArray

      An array of nsIJumpListItem items to add to the list.

    • catName: string

      For custom lists, the title of the list.

    Returns boolean

commitListBuild

  • Commits the current jump list build to the Taskbar.

    Parameters

    • callback: nsIJumpListCommittedCallback

      Receives one argument, which is true if the operation completed successfully, otherwise it is false.

    Returns void

deleteActiveList

  • Deletes any currently applied taskbar jump list for this application. Common uses would be the enabling of a privacy mode and uninstallation.

    Returns

    true if the operation completed successfully.

    Throw

    NS_ERROR_UNEXPECTED on internal errors.

    Returns boolean

initListBuild

  • Initializes a jump list build and returns a promise with the list of items the user removed since the last time a jump list was committed. Removed items can become state after initListBuild is called, lists should be built in single-shot fasion.

    Returns

    a promise with the list of items that were removed by the user since the last commit.

    Returns any

setAppUserModelID

  • Parameters

    • aAppUserModelId: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc