WatchFolder
Represents a common ancestor of classes that represent tags and saved searches.
Extends BaseEntity.
Properties
Name | Type | Description | Read-only |
|---|---|---|---|
becomesRemoved | | When `true`, the entity is removed in the current transaction. Otherwise, `false`. Available since 2017.4.37915 |  |
isNew | | When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351 | |
name | | The name of the tag or saved search. | |
shareGroup | | The group of users for whom the tag or saved search is visible. If the tag or the saved search is only visible to its owner, the value for this property is `null`. | |
updateShareGroup | | The group of users who are allowed to update the settings for the tag or saved search. If the tag or the saved search can only be updated by its owner, the value for this property is `null`. | |
Methods
becomes
becomes(fieldName, expected)Checks whether a field is set to an expected value in the current transaction.
Parameters
Name | Type | Description |
|---|---|---|
fieldName | | The name of the field to check. |
expected | | The expected value. |
Return Value
Type | Description | |
|---|---|---|
| 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 | | The name of the field. |
user | | The user for whom the permission to read the field is checked. |
Return Value
Type | Description | |
|---|---|---|
| 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 | | The name of the field. |
user | | The user for whom the permission to update the field is checked. |
Return Value
Type | Description | |
|---|---|---|
| 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 | | The name of the field to check. |
Return Value
Type | Description | |
|---|---|---|
| If the value of the field is changed in the current transaction, returns `true`. |
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 | | The name of the field. |
Return Value
Type | Description | |
|---|---|---|
| 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 | | The name of the field to check. |
message | | The message that is displayed to the user that describes the field requirement. |