Root definitions

UserNoteCriteria

Permalink

Properties

count

string

Number of occurrences of this type. Ignored if search is current

A string containing a comparison operator and/or a value to compare number of occurrences against

The syntax is (< OR > OR <= OR >=) <number>[percent sign] [in timeRange] [ascending|descending]

If timeRange is given then only notes/mod actions that occur between timeRange and NOW will be returned. timeRange is ignored if search is current

Default: >= 1, Pattern: ^\s*(?<opStr>>|>=|<|<=)\s*(?<value>\d+)\s*(?<percent>%?)\s*(?<duration>in\s+\d+\s*(days?|weeks?|months?|years?|hours?|minutes?|seconds?|milliseconds?))?\s*(?<extra>asc.*|desc.*)*$
note

anyOf [Array<string>, string]

The content of the Note to search For.

  • Can be a single string or list of strings to search for. Each string will be searched for case-insensitive, as a subset of note content.
  • Can also be Regular Expression if wrapped in forward slashes IE '/test.*/i'
referencesCurrentActivity

boolean

search

string

How to test the Toolbox Notes or Mod Actions for this Author:

current

Only the most recent note is checked for criteria

total

count comparison of mod actions/notes must be found within all history

  • EX count: > 3 => Must have more than 3 notes of type, total
  • EX count: <= 25% => Must have 25% or less of notes of type, total
  • EX: count: > 3 in 1 week => Must have more than 3 notes within the last week

consecutive

The count number of mod actions/notes must be found in a row.

You may also specify the time-based order in which to search the notes by specifying ascending (asc) or descending (desc) in the count value. Default is descending

  • EX count: >= 3 => Must have 3 or more notes of type consecutively, in descending order
  • EX count: < 2 => Must have less than 2 notes of type consecutively, in descending order
  • EX count: > 4 asc => Must have greater than 4 notes of type consecutively, in ascending order
Default: current

Valid values: consecutive, current, total

type Required

string

User Note type key to search for

Loading...

Editor and Validator