workflow

This module contains utility functions that display workflow-related messages and warnings in the user interface.

Functions

check

static check(condition, message)

Checks to determine whether the specified condition is true. If the condition is not true, the system throws an error. All changes are rolled back to the initial state.. The error contains the specified message, which is displayed in the user interface.

Parameters

Name	Type	Description
condition	boolean	The condition to check.
message	string	The error message that is shown to the user in cases where the condition is false.

Example

workflow.check(issue.fields.Assignee && ctx.currentUser.login === issue.fields.Assignee.login,
  'Only Assignee can mark issue as Fixed.');

i18n

static i18n(messageId)

Returns a localized version of a message. WARNING: for internal use only! This method is only supported in default workflows where the IDs and text strings for localized messages are stored in the application. References to this method in custom workflows are not supported.

Parameters

Name	Type	Description
messageId	string	The message ID.

Return Value

Type	Description
Object	An object that contains the placeholders and localized strings that are associated with the specified message. When this object is passed to a function that expects a string value, the toString method is called internally, replacing the parameters with the localized string.

message

static message(messageText)

Displays the specified message in the YouTrack user interface.

Parameters

Name	Type	Description
messageText	string	The message text.

Last modified: 30 March 2021