Class Tasks

constructor

• new Tasks(): Tasks

• Returns Tasks

isDefault

Static tasksConfiguration

afterSaveHookAddComment

• afterSaveHookAddComment(event): void

• Parameters

  • event: IItemChangeEvent

  Returns void

createControl

• createControl(ctrl, options): void

• Parameters

  • ctrl: JQuery

  • options: IBaseControlOptions

  Returns void

evaluateTaskIds

• evaluateTaskIds(comment): string[]

• Parameters

  • comment: string

  Returns string[]

getProjectPagesAsync

• getProjectPagesAsync(): Promise<IProjectPageParam[]>

• Returns Promise<IProjectPageParam[]>

initItem

• initItem(_item, _jui): void

• Parameters

  • _item: IItem

  • _jui: JQuery

  Returns void

initProject

• initProject(): void

• Returns void

initServerSettings

• initServerSettings(serverSettings): void

• Parameters

  • serverSettings: XRListProjectAndSettings

  Returns void

isPluginEnabled

• isPluginEnabled(pluginId): boolean

• Parameters

  • pluginId: number

  Returns boolean

preSaveHookAsync

• preSaveHookAsync(isItem, type, controls): Promise<unknown>

• Parameters

  • isItem: boolean

  • type: string

  • controls: IControlDefinition[]

  Returns Promise<unknown>

reset

• reset(): void

• Returns void

subscribe

• subscribe(): void

• Returns void

supportsControl

• supportsControl(fieldType): boolean

• Returns true if the plugin offers a control that can display fields of type {fieldType}.

  Parameters

  • fieldType: string

  Returns boolean

updateMenu

• updateMenu(ul, hook): void

• Parameters

  • ul: JQuery

  • hook: number

  Returns void

Static appendIssueItems

• appendIssueItems(parentElement, folderItems, selectedFolders, folderChangeCallback, folders?): void

• Parameters

  • parentElement: JQuery

  • folderItems: FolderItem[]

  • selectedFolders: string[]

  • folderChangeCallback: ((folder) => void)

    • • (folder): void

      • Parameters

        • folder: Folder

        Returns void

  • Optional folders: Folder[]

  Returns void

Static createOne2OneTask

• createOne2OneTask(itemId): JQueryDeferred<IExternalItem>

• Parameters

  • itemId: string

  Returns JQueryDeferred<IExternalItem>

Static createTaskFromUrl

• createTaskFromUrl(itemId, url): void

• Parameters

  • itemId: string

  • url: string

  Returns void

Static deleteLink

• deleteLink(itemId, task): JQueryDeferred<{}>

• Parameters

  • itemId: string

  • task: IExternalItem

  Returns JQueryDeferred<{}>

Static externalItemFromUrl

• externalItemFromUrl(url): IExternalItem

• Parameters

  • url: string

  Returns IExternalItem

Static fillTree

• fillTree(tree, alltasks): FolderItem[]

• Parameters

  • tree: IDB[]

  • alltasks: IWltItemWithLinks[]

  Returns FolderItem[]

Static getAllTasksProject

• getAllTasksProject(plugin): JQueryDeferred<IWltItemWithLinks[]>

• Parameters

  • plugin: number

  Returns JQueryDeferred<IWltItemWithLinks[]>

Static getConfig

• getConfig(pluginId): ITaskConfiguration

• Parameters

  • pluginId: number

  Returns ITaskConfiguration

Static getMeta

• getMeta(pluginId, externalItemId): JQueryDeferred<IExternalItem>

• Parameters

  • pluginId: number

  • externalItemId: string

  Returns JQueryDeferred<IExternalItem>

Static getOne2OneRenderInfo

• getOne2OneRenderInfo(task?): ITaskRenderInfo

• Parameters

  • Optional task: IExternalItem

  Returns ITaskRenderInfo

Static getOne2OneTask

• getOne2OneTask(externalItemId): JQueryDeferred<IExternalItem>

• Parameters

  • externalItemId: string

  Returns JQueryDeferred<IExternalItem>

Static getTasks

• getTasks(itemId?, pluginFilter?): JQueryDeferred<IExternalItem[]>

• Parameters

  • Optional itemId: string

  • Optional pluginFilter: number[]

  Returns JQueryDeferred<IExternalItem[]>

Static isFolder

• isFolder(item): item is Folder

• Parameters

  • item: FolderItem

  Returns item is Folder

Static isTaskId

• isTaskId(someId): boolean

• Parameters

  • someId: string

  Returns boolean

Static postCreateIssue

• postCreateIssue(pluginId, itemId, title, description, projectId, taskTypeId): JQueryDeferred<IExternalItem[]>

• Parameters

  • pluginId: number

  • itemId: string

  • title: string

  • description: string

  • projectId: string

  • taskTypeId: string

  Returns JQueryDeferred<IExternalItem[]>

Static postCreateLinks

• postCreateLinks(itemId, tasksToLink): JQueryDeferred<IExternalItem[]>

• rest api

  Parameters

  • itemId: string

  • tasksToLink: IExternalItem[]

  Returns JQueryDeferred<IExternalItem[]>

Static postPushIssue

• postPushIssue(pluginId, itemId, title, description, projectId, taskTypeId): Promise<IExternalItem[]>

• Parameters

  • pluginId: number

  • itemId: string

  • title: string

  • description: string

  • projectId: string

  • taskTypeId: string

  Returns Promise<IExternalItem[]>

Static renderTask

• renderTask(itemId, task, unlink, fullWidth, tinyLink?): JQuery

• Parameters

  • itemId: string

  • task: IExternalItem

  • unlink: boolean

  • fullWidth: boolean

  • Optional tinyLink: boolean

  Returns JQuery

Static renderTasks

• renderTasks(itemId, linkedTasks, root, canEdit, fullWidth): void

• Parameters

  • itemId: string

  • linkedTasks: IExternalItem[]

  • root: JQuery

  • canEdit: boolean

  • fullWidth: boolean

  Returns void

Static showError

• showError(text, jqxhr, textStatus, error): void

• Parameters

  • text: string

  • jqxhr: IJcxhr

  • textStatus: string

  • error: string

  Returns void

Static showTasks

• showTasks(itemId, control, canEdit, pluginFilter?): void

• Parameters

  • itemId: string

  • control: JQuery

  • canEdit: boolean

  • Optional pluginFilter: number[]

  Returns void