electron/docs/api/structures/jump-list-item.md

# JumpListItem Object

* `type` String (optional) - One of the following:
  * `task` - A task will launch an app with specific arguments.
  * `separator` - Can be used to separate items in the standard `Tasks`
    category.
  * `file` - A file link will open a file using the app that created the
    Jump List, for this to work the app must be registered as a handler for
    the file type (though it doesn't have to be the default handler).
* `path` String (optional) - Path of the file to open, should only be set if `type` is
  `file`.
* `program` String (optional) - Path of the program to execute, usually you should
  specify `process.execPath` which opens the current program. Should only be
  set if `type` is `task`.
* `args` String (optional) - The command line arguments when `program` is executed. Should
  only be set if `type` is `task`.
* `title` String (optional) - The text to be displayed for the item in the Jump List.
  Should only be set if `type` is `task`.
* `description` String (optional) - Description of the task (displayed in a tooltip).
  Should only be set if `type` is `task`. Maximum length 260 characters.
* `iconPath` String (optional) - The absolute path to an icon to be displayed in a
  Jump List, which can be an arbitrary resource file that contains an icon
  (e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to
  show the program icon.
* `iconIndex` Number (optional) - The index of the icon in the resource file. If a
  resource file contains multiple icons this value can be used to specify the
  zero-based index of the icon that should be displayed for this task. If a
  resource file contains only one icon, this property should be set to zero.
* `workingDirectory` String (optional) - The working directory. Default is empty.
Rename bounds -> rectangle 2016-10-08 02:09:31 +00:00			`# JumpListItem Object`
Move reused object structures to a standard structures folder 2016-09-28 07:00:01 +00:00
Put optional label before dash 2016-12-29 22:11:26 +00:00			* `type` String (optional) - One of the following:
Move reused object structures to a standard structures folder 2016-09-28 07:00:01 +00:00			* `task` - A task will launch an app with specific arguments.
			* `separator` - Can be used to separate items in the standard `Tasks`
			`category.`
			* `file` - A file link will open a file using the app that created the
			`Jump List, for this to work the app must be registered as a handler for`
			`the file type (though it doesn't have to be the default handler).`
Put optional label before dash 2016-12-29 22:11:26 +00:00			* `path` String (optional) - Path of the file to open, should only be set if `type` is
Move reused object structures to a standard structures folder 2016-09-28 07:00:01 +00:00			`file`.
Put optional label before dash 2016-12-29 22:11:26 +00:00			* `program` String (optional) - Path of the program to execute, usually you should
Move reused object structures to a standard structures folder 2016-09-28 07:00:01 +00:00			specify `process.execPath` which opens the current program. Should only be
			set if `type` is `task`.
Put optional label before dash 2016-12-29 22:11:26 +00:00			* `args` String (optional) - The command line arguments when `program` is executed. Should
Move reused object structures to a standard structures folder 2016-09-28 07:00:01 +00:00			only be set if `type` is `task`.
Put optional label before dash 2016-12-29 22:11:26 +00:00			* `title` String (optional) - The text to be displayed for the item in the Jump List.
Move reused object structures to a standard structures folder 2016-09-28 07:00:01 +00:00			Should only be set if `type` is `task`.
Put optional label before dash 2016-12-29 22:11:26 +00:00			* `description` String (optional) - Description of the task (displayed in a tooltip).
fix: reject task append to JumpList when description exceeds 260 characters (#28485) * fix: reject task when description exceeds 260 characters * Switched out wcslen() for size() [linear -> constant time] * Included comment describing the need for the additional check * Added information about character limit to documentation * Added newline character to end of jump-list-category.md 2021-04-05 23:50:39 +00:00			Should only be set if `type` is `task`. Maximum length 260 characters.
Put optional label before dash 2016-12-29 22:11:26 +00:00			* `iconPath` String (optional) - The absolute path to an icon to be displayed in a
Move reused object structures to a standard structures folder 2016-09-28 07:00:01 +00:00			`Jump List, which can be an arbitrary resource file that contains an icon`
			(e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to
			`show the program icon.`
Put optional label before dash 2016-12-29 22:11:26 +00:00			* `iconIndex` Number (optional) - The index of the icon in the resource file. If a
Move reused object structures to a standard structures folder 2016-09-28 07:00:01 +00:00			`resource file contains multiple icons this value can be used to specify the`
			`zero-based index of the icon that should be displayed for this task. If a`
			`resource file contains only one icon, this property should be set to zero.`
feat: allow setting working directory in app.setUserTasks() / app.setJumpList() (#18148) 2019-05-13 16:17:12 +00:00			* `workingDirectory` String (optional) - The working directory. Default is empty.