noitidart / trigger-community

Repository of custom commands shared by users of the Trigger browser extension

Trigger Community

Repository of custom commands shared by users of the Trigger browser extension. Please do not manualy submit pull requests. Please use Trigger dashboard to create and submit command (userscripts).

API

Here is the documentation on the special functions available to commands.

Interfaces
browser
system

browser

The complete browser.* interface of WebExtensions is available. You can read about the details here at MDN :: WebExtensions - APIs.

There are two critical differences:

1. Callbacks cannot be used.
2. All methods return a promise (which resolves with the expected arguments), even if MDN documentation says they do not.

For example, in the Trigger localization file I have a string called error. Normally you would obtain this string by doing let str_error = browser.i18n.getMessage('error'), becuase MDN docs says this returns a string synchronously. However we are in the Trigger command/userscript scope, so it returns a promise. Here are ways how you can handle this:

ES5

browser.i18n.getMessage('error').then(function(result) {
    let str_error = result;
});

ES7

let str_error = await browser.i18n.getMessage('error');

system

This branch offers a collection of modules similar to the browser API. The functionality here is focused on operating system specifics.

Modules
file
input
path

system.file

This module enables manipulating files on the system.

Methods
launch - promise<> system.file.launch(string path)

Methods

launch

promise<> system.file.launch(string path)

Tries to launch the file at path. If the file is directory, it will open it in the platform file viewer. If the file is a special type of file (text, image, etc) it will open it with the default application for that file type. If the file is a program, it will launch it detached. The promise is resolved with no arguments after the attempt to launch is made. If the attempt to launch fails for any reason, it is still not resolved with any arguments.

system.input

This module works with the input mechanisms and devices of the platform. Devices include keyboard, mouse. Mechanisms include window messages.

Methods
sendKey - promise<> system.input.sendKey(string codename)

Methods

sendKey

promise<> system.input.sendKey(string codename)

This sends a synthesized key to whatever is currently focused. It returns a promise which resolves with no arguments after the key was sent. If the key fails to send it is silent, meaning there are still no arguments passed to the resolving callback. The argument codename is a string and is platform dependent. For instance the codename for the "A" key on Windows is "VK_A", on Linux it is "XK_A", and on Mac it is "kVK_ANSI_A". You can find a list of these codenames at:

• Windows - MSDN :: Virtual Key Codes
• Linux - Github :: Noitidart / ostypes - ostypes_x11.jsm L1128-L1578
• Mac - Github :: Noitidart / ostypes - ostypes_mac.jsm L630-L747

You can instead set codename to a string of the code number surrounded by single quotes. For example, the code "XK_A" corresponds to a number value of 65 - so calling system.input.sendKey("XK_A") is the same as calling system.input.sendKey("'65'")

Important Notes There are future plans to make the keys cross platform, and the platform dependent keys will maintain the platform prefix. This was already implemented for Windows, so any "VK_" prefix should not be used - example: if the code name is "VK_A" just send "A".

system.path

This module provides information and methods on the system file paths.

Types
PathName

Methods
get - promise<string path> system.path.get(PathName name)

Types

PathName

The first argument passed to system.path.get. Identifies that you want special path on the system.

Enum
"desktop", "temp", "home", "user_app_data", "program_files"

• Windows Only - "user_app_data", "program_files"
• Linux Only - "home"

Methods

get

promise<string path> system.path.get(PathName name)

Returns a promise which resolves with the first argument path being a string of the special system path associated with the name. If name is not valid then it resolves with a path being a blank string.