Optional aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
Do a dry run of pinCurrentAppToTaskbar().
NOTE: Can only be run on the main thread, but the actual work occurs on a background thread.
This does all the same checks and setup, throws the same errors, but doesn't do the final step of creating the pin.
same as pinCurrentAppToTaskbarAsync()
same as pinCurrentAppToTaskbarAsync()
same as pinCurrentAppToTaskbarAsync()
Determine where a given shortcut likely appears in the shell.
Returns one of:
If a Private Browsing shortcut was used to launch, the "Private" variant of one of the above entries will be returned.
NOTE: This tries to avoid I/O, so paths are compared directly as strings, which may not be accurate in all cases. It is intended for noncritical telemetry use.
Creates a new shortcut (.lnk) file. This shortcut will be recorded in a new shortcuts log file located in %PROGRAMDATA%\Mozilla-1de4eec8-1241-4177-a864-e594e8d1fb38 that is named after the currently running application and current user, eg: Firefox_user123_shortcuts.ini.
For reasons that we haven't been able to pin down, these shortcuts get created with extra metadata on them (KnownFolderDataBlock, SpecialFolderDataBlock) that cause the Windows ShellLink classes to improperly read their target path with certain parameters. This causes any 32-bit programs that read the links (such as our installer and uninstaller) to think that 64-bit installs are located in the 32-bit Program Files directory. See https://social.msdn.microsoft.com/Forums/windowsdesktop/en-US/6f2e7920-50a9-459d-bfdd-316e459e87c0/ishelllink-getpath-returns-wrong-folder-for-64-bit-application-when-called-from-32-bit-application for some additional discussion of this.
The full native path to the created shortcut.
NS_ERROR_INVALID_ARG if an invalid shortcut folder is passed
NS_ERROR_FILE_NOT_FOUND if the shortcut file or shortcuts log cannot be created or accessed
NS_ERROR_FAILURE for other types of failures
Target file of the shortcut.
Arguments to set for the shortcut. May be empty.
The description of the shortcut. The string used here shows up as the hover text of the shortcut in Explorer and on the Taskbar (if the shortcut is pinned there).
The file containing the desired icon for the shortcut. This can be the same file as aBinary.
The index of the in aIconFile. Note that this is 0 based index that IShellLinkW requires, not a Resource ID that is sometimes used for icons.
The App User Model ID to set for the shortcut. This will affect which icon on the Taskbar the application groups with when first launched.
The special Windows folder to create the shortcut in. One of: CommonStartMenu, StartMenu, PublicDesktop, Desktop, or QuickLaunch.
The filename of the shortcut within aShortcutFolder.
Search for the current executable among taskbar pins
NOTE: Can only be run on the main thread, but the actual work occurs on a background thread.
NOTE: It is possible for the check to fail even when a taskbar pin refers to this executable, if the paths differ due to e.g. symlinks. It is also possible for the check to succeed with a shortcut that doesn't actually appear on the taskbar. These cases should be rare.
Promise that always resolves, true if pinned, false otherwise
NS_ERROR_NOT_SAME_THREAD if not run on the main thread
Pin the current app to the taskbar. If aPrivateBrowsing is true, the Private Browsing version of the app (with a different icon and launch arguments) will be pinned instead.
This MUST only be used in response to an active request from the user.
If it exists, uses an existing shortcut on the Desktop or Start Menu, which would have been created by the installer (for All Users or Current User). If none can be found, one will be created with the correct AUMID for proper launching and grouping.
NOTE: It is possible for the shortcut match to fail even when a shortcut refers to the current executable, if the paths differ due to e.g. symlinks. This should be rare.
This is fully supported on Windows 7, 8, and 11. On Windows 10, it will definitely fail on a version prior to build 1809 (October 2018 Update).
NOTE: Can only run on the main thread, but the actual work occurs on a background thread.
NS_ERROR_NOT_SAME_THREAD if called off main thread.
NS_ERROR_NOT_AVAILABLE if OS is not at least Windows 10 build 1809, or if creating the Taskband Pin object fails
NS_ERROR_FAILURE for unexpected errors
NS_ERROR_FILE_NOT_FOUND if a shortcut matching this app's AUMID and exe path wasn't found
A promise that resolves to |undefined| if successful or rejects with an nserror.
Return the Windows ProgID currently registered to handle the gven file extension (like ".pdf") or protocol (like "https").
string ProgID, or "" when no association is registered.
NS_ERROR_FAILURE when the file extension or protocol cannot be determined.
Generated using TypeDoc
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.