Root definitions

BanActionJson

Permalink

Ban the Author of the Activity this Check is run on

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.

dryRun

boolean

If true the Action will not make the API request to Reddit to perform its action.

Default: false
duration

number

Number of days to ban the Author. If not specified Author will be banned permanently.

Minimum: 1, Maximum: 999
enable

boolean

If set to false the Action will not be run

Default: true
footer

anyOf [boolean, string]

Customize the footer for Actions that send replies (Comment/Ban)

If false no footer is appended

If string the value is rendered as markdown or will use wiki: parser the same way content properties on Actions are rendered with templating.

If footer is undefined (not set) the default footer will be used:


This action was performed by [a bot.] Mention a moderator or [send a modmail] if you any ideas, questions, or concerns about this action.


The following properties are available for templating:

Copy
1 2 3 4 subName => name of subreddit Action was performed in (EX 'mealtimevideos') permaLink => The permalink for the Activity the Action was performed on EX https://reddit.com/r/yourSub/comments/o1h0i0/title_name/1v3b7x modmaiLink => An encoded URL that will open a new message to your subreddit with the Action permalink appended to the body botLink => A permalink to the FAQ for this bot.

If you use your own footer or no footer please link back to the bot FAQ using the {{botLink}} property in your content :)

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 action that will be performed

Valid values: ban

message

string

The message that is sent in the ban notification. message is interpreted as reddit-flavored Markdown.

If value starts with wiki: then the proceeding value will be used to get a wiki page

EX wiki:botconfig/mybot tries to get https://reddit.com/mySubredditExample/wiki/botconfig/mybot

EX this is plain text => "this is plain text"

EX this is **bold** markdown text => "this is bold markdown text"

name

string

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

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

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

string

A mod note for this ban. Can use Templating. If the length expands to more than 100 characters it will truncated with "..."

reason

string

Reason for ban. Can use Templating. If the length expands to more than 100 characters it will truncated with "..."

Loading...

Editor and Validator