Work Item Web Links

IssueRemoteLinksWidget

class IssueRemoteLinksWidget

Bases: textual.containers.VerticalScroll

A container for adding and updating the list of remote links (aka. web links) associated to a work item.

This widget is responsible for the following:

• opening the modal screen that allows users to add new links.

• fetching the list of remote links associated to the work item.

• adding a new link to the work item.

• deleting a link when the message jiratui.widgets.remote_links.links.IssueRemoteLinkCollapsible.Deleted is posted

See Also:

• Use Case: Add Web Link

• Architecture: Create Work Item

Initialization

Construct a scrollable container.

Parameters:

• children – Child widgets.

• name – The name of the widget.

• id – The ID of the widget in the DOM.

• classes – The CSS classes for the widget.

• disabled – Whether the widget is disabled or not.

• can_focus – Can this container be focused?

• can_focus_children – Can this container’s children be focused?

• can_maximized – Allow this container to maximize? None to use default logic.,

on_issue_remote_link_collapsible_deleted(message: jiratui.widgets.remote_links.links.IssueRemoteLinkCollapsible) → None

Schedules a task to delete a link.

async action_add_remote_link() → None

Handles the event to open a pop-up screen to add a remote (web) link to a work item.

Returns:

None.

add_link(data: dict | None = None) → None

Processes the callback form the modal screen and adds the link to the work item.

Parameters:

data – the data related to the link we need to add.

Returns:

None

async create_link(data: dict) → None

Creates the actual link for the work item and updates the list of links that are displayed for the item.

Parameters:

data – the data related to the link we need to add. Expects link_url and link_title.

Returns:

None

async fetch_remote_links(issue_key: str) → None

Retrieves the remote links of a work item and displays them as a list of collapsible widgets in the screen.

Parameters:

issue_key – the case-sensitive key of the item.

Returns:

None

watch_issue_key(issue_key: str | None = None) → None

Updates the remote links of the work item being displayed every time a new work item is set for the widget.

Parameters:

issue_key – the case-sensitive key of the item.

Returns:

None

IssueRemoteLinkCollapsible

class IssueRemoteLinkCollapsible(*args, **kwargs)

Bases: textual.widgets.Collapsible

A collapsible to show a remote link associated to a work item.

The widget posts the message jiratui.widgets.remote_links.links.IssueRemoteLinkCollapsible.Deleted when a link is deleted.

See Also:

• Use Case: Delete Web Link

Initialization

Initialize a Collapsible widget.

Parameters:

• children – Contents that will be collapsed/expanded.

• title – Title of the collapsed/expanded contents.

• collapsed – Default status of the contents.

• collapsed_symbol – Collapsed symbol before the title.

• expanded_symbol – Expanded symbol before the title.

• name – The name of the collapsible.

• id – The ID of the collapsible in the DOM.

• classes – The CSS classes of the collapsible.

• disabled – Whether the collapsible is disabled or not.

class Deleted(work_item_key: str, link_id: str)

Bases: textual.message.Message

Posted when a link is deleted.

It holds the key of the work item whose link we deleted and the ID of the deleted link.

Initialization

async action_delete_remote_link() → None

Opens a modal screen to ask the user if they want to delete a remote link or not.

Returns:

None