YouTrack Standalone 2019.1 Help

UserGroup

Represents a group of users.

Extends BaseEntity.

Properties

Name

Type

Description

static allUsersGroup

UserGroup

Read-only. The All Users group.

static fieldType

String

Read-only. Field type. Used when defining rule requirements.

becomesRemoved

Boolean

Read-only. When `true`, the entity is removed in the current transaction. Otherwise, `false`.

Available since 2017.4.37915

description

String

Read-only. The description of the group.

isAllUsersGroup

Boolean

Read-only. If the group is the All Users group, this property is `true`.

isAutoJoin

Boolean

Read-only. If the auto-join option is enabled for the group, this property is `true`.

isNew

Boolean

Read-only. When `true`, the entity is created in the current transaction. Otherwise, `false`.

Available since 2018.2.42351

name

String

Read-only. The name of the group.

users

Set.<User>

Read-only. A list of users who are members of the group.

Methods


findByName

static findByName(name)

Finds a group by name.

Parameters

Name

Type

Description

name

String

The name of the group to search for.

Return Value

Type

Description

UserGroup

The specified user group, or null when a group with the specified name is not found.

 

becomes

becomes(fieldName, expected)

Checks whether a field is set to an expected value in the current transaction.

Parameters

Name

Type

Description

fieldName

string

The name of the field to check.

expected

string

The expected value.

Return Value

Type

Description

boolean

If the field is set to the expected value, returns `true`.

 

canBeReadBy

canBeReadBy(fieldName, user)

Checks whether a user has permission to read the field.

Parameters

Name

Type

Description

fieldName

string

The name of the field.

user

User

The user for whom the permission to read the field is checked.

Return Value

Type

Description

boolean

If the user can read the field, returns `true`.

 

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Checks whether a user has permission to update the field.

Parameters

Name

Type

Description

fieldName

string

The name of the field.

user

User

The user for whom the permission to update the field is checked.

Return Value

Type

Description

boolean

If the user can update the field, returns `true`.

 

isChanged

isChanged(fieldName)

Checks whether the value of a field is changed in the current transaction.

Parameters

Name

Type

Description

fieldName

string

The name of the field to check.

Return Value

Type

Description

boolean

If the value of the field is changed in the current transaction, returns `true`.

 

notifyAllUsers

notifyAllUsers(subject, body)

Sends an email notification to all of the users who are members of the group.

Parameters

Name

Type

Description

subject

String

The subject line of the email notification.

body

String

The message text of the email notification.

Example

issue.oldValue('permittedGroup').notifyAllUsers('Visibility has been changed', 'The visibility group for the issue ' + issue.getId() + ' has been changed to ' + permittedGroup.name);

 

oldValue

oldValue(fieldName)

Returns the previous value of a single-value field before an update was applied. If the field is not changed in the transaction, returns null.

Parameters

Name

Type

Description

fieldName

string

The name of the field.

Return Value

Type

Description

Object

If the field is changed in the current transaction, the previous value of the field. Otherwise, null.

 

required

required(fieldName, message)

Asserts that a value is set for a field. If a value for the required field is not set, the specified message is displayed in the user interface.

Parameters

Name

Type

Description

fieldName

string

The name of the field to check.

message

string

The message that is displayed to the user that describes the field requirement.

 

Last modified: 18 June 2019