Root definitions

AuthorRuleJSONConfig

Permalink

Properties

authorIs

anyOf [Array<anyOf [AuthorCriteria, NamedCriteria<AuthorCriteria>, string]>, FilterOptionsJson<AuthorCriteria>]

If present then these Author criteria are checked before running the Check. If criteria fails then the Check will fail.

exclude

Array<anyOf [AuthorCriteria, NamedCriteria<AuthorCriteria>]>

Only runs if include is not present. Will "pass" if any of set of the AuthorCriteria does not pass

include

Array<anyOf [AuthorCriteria, NamedCriteria<AuthorCriteria>]>

Will "pass" if any set of AuthorCriteria passes

itemIs

anyOf [Array<anyOf [SubmissionState, CommentState, NamedCriteria<TypedActivityState>, string]>, FilterOptionsJson<TypedActivityState>]

A list of criteria to test the state of the Activity against before running the check.

If any set of criteria passes the Check will be run. If the criteria fails then the Check will fail.

  • @examples [[{"over_18": true, "removed': false}]]
kind Required

string

The kind of rule to run

Valid values: author

name

string

An optional, but highly recommended, friendly name for this rule. If not present will default to kind.

Can only contain letters, numbers, underscore, spaces, and dashes

name is used to reference Rule result data during Action content templating. See CommentAction or ReportAction for more details.

Pattern: ^[a-zA-Z]([\w -]*[\w])?$
Loading...

Editor and Validator