Root definitions

SubmissionCheckConfigData

Permalink

Properties

actions

Array<anyOf [IncludesData, FlairActionJson, UserFlairActionJson, CommentActionJson, ReportActionJson, LockActionJson, RemoveActionJson, UserNoteActionJson, ApproveActionJson, BanActionJson, MessageActionJson, DispatchActionJson, CancelDispatchActionJson, ContributorActionJson, ModNoteActionJson, SubmissionActionJson, string]>

The Actions to run after the check is successfully triggered. ALL Actions will run in the order they are listed

Can be Action or the name of any named Action in your subreddit's configuration

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.

cacheUserResult

UserResultCacheOptions

Cache the result of this check based on the comment author and the submission id

This is useful in this type of scenario:

  1. This check is configured to run on comments for specific submissions with high volume activity
  2. The rules being run are not dependent on the content of the comment
  3. The rule results are not likely to change while cache is valid
condition

string

Under what condition should a set of run Rule objects be considered "successful"?

If OR then any triggered Rule object results in success.

If AND then all Rule objects must be triggered to result in success.

Default: AND

Valid values: AND, OR

description

string

dryRun

boolean

Use this option to override the dryRun setting for all of its Actions

enable

boolean

Should this check be run by the bot?

Default: true
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 type of event (new submission or new comment) this check should be run against

Valid values: submission

name Required

string

Friendly name for this Check EX "crosspostSpamCheck" Can only contain letters, numbers, underscore, spaces, and dashes

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

boolean

If notifications are configured and this is true then an eventActioned event will be sent when this check is triggered.

Default: false
postFail

anyOf [PostBehaviorOptionConfig, string]

Do this behavior if a Check is NOT triggered

Default: next
postTrigger

anyOf [PostBehaviorOptionConfig, string]

Do this behavior if a Check is triggered

Default: nextRun
rules

Array<anyOf [IncludesData, RecentActivityRuleJSONConfig, RepeatActivityJSONConfig, AuthorRuleJSONConfig, AttributionJSONConfig, HistoryJSONConfig, RegexRuleJSONConfig, RepostRuleJSONConfig, SentimentRuleJSONConfig, MHSRuleJSONConfig, RuleSetConfigData, string]>

A list of Rules to run.

If Rule objects are triggered based on condition then actions will be performed.

Can be Rule, RuleSet, or the name of any named Rule in your subreddit's configuration.

If rules is an empty array or not present then actions are performed immediately.

Loading...

Editor and Validator