YouTrack Standalone 2017.2 Help

SavedQuery

Extends: WatchFolder

Represents a saved query (search).

Properties

NameTypeDescriptionRead-only
name String The name of the tag or the saved query (search). /help/img/youtrack/2017.2/checkbox-marked.png
owner User The User who created the saved query (search). /help/img/youtrack/2017.2/checkbox-marked.png
query String The query string. /help/img/youtrack/2017.2/checkbox-marked.png
shareGroup UserGroup The `UserGroup` for whom the tag or the saved query (search) is visible.If the tag or the saved query (search) is visible only to its owner, returns `null`. /help/img/youtrack/2017.2/checkbox-marked.png
updateShareGroup UserGroup The `UserGroup` for whom the tag or the saved query (search) is updatable.If the tag or the saved query (search) is updatable only to its owner, returns `null`. /help/img/youtrack/2017.2/checkbox-marked.png

Methods

 

findByName

static findByName(name)

Get saved queries (searches) visible to current user with a given name.User's own saved queries go first.

Parameters:

NameTypeDescription
name String Saved query name.

Returns:

TypeDescription
Set.<SavedQuery> Sequence of saved queries.

 

findQueryByName

static findQueryByName(name)

Get the most relevant saved query (search) with this name, which is visible to the current user.

Parameters:

NameTypeDescription
name String Saved query name.

Returns:

TypeDescription
SavedQuery The most relevant saved query.

 

becomes

becomes(fieldName, expected)

Checks that a value a field receives in the current transaction is equal to an expected one.

Parameters:

NameTypeDescription
fieldName string name of the field to check.
expected string expected value.

Returns:

TypeDescription
boolean `true` in case the expectation is met.

 

canBeReadBy

canBeReadBy(fieldName, user)

Checks if a field can be read by a user.

Parameters:

NameTypeDescription
fieldName string name of the field.
user User to check access for.

Returns:

TypeDescription
boolean `true` in case the field can be read by the user.

 

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Checks if a field can be written by a user.

Parameters:

NameTypeDescription
fieldName string name of the field.
user User to check access for.

Returns:

TypeDescription
boolean `true` in case the field can be written by the user.

 

isChanged

isChanged(fieldName)

Checks if a field is changed in the current transaction.

Parameters:

NameTypeDescription
fieldName string name of the field (e.g. 'summary') to check.

Returns:

TypeDescription
boolean `true` in case the field is changed in the current transaction.

 

oldValue

oldValue(fieldName)

Returns the previous value of a single-valued field before an update was applied. In case the field is not changedin the transaction, this value is equal to the current value of the field.

Parameters:

NameTypeDescription
fieldName string name of the field (e.g. 'updated') to get previous value of.

Returns:

TypeDescription
Object previous value of the field.

 

required

required(fieldName, message)

Checks if a the entity has a field denoted by field name set, shows error message otherwise.

Parameters:

NameTypeDescription
fieldName string name of the field to check.
message string message to show in case the field is not set.

 

Last modified: 9 August 2017