Root definitions

PollingOptions

Permalink

A configuration for where, how, and when to poll Reddit for Activities to process

Properties

delayUntil

number

Delay processing Activity until it is N seconds old

Useful if there are other bots that may process an Activity and you want this bot to run first/last/etc.

If the Activity is already N seconds old when it is initially retrieved no refresh of the Activity occurs (no API request is made) and it is immediately processed.

interval

number

Amount of time, in seconds, to wait between requests

Default: 30
limit

number

The maximum number of Activities to get on every request

Default: 50
pollOn Required

string

What source to get Activities from. The source you choose will modify how the bots behaves so choose carefully.

unmoderated (default)

Activities that have yet to be approved/removed by a mod. This includes all modqueue (reports/spam) and new submissions.

Use this if you want the bot to act like a regular moderator and act on anything that can be seen from mod tools.

Note: Does NOT include new comments, only comments that are reported/filtered by Automoderator. If you want to process all unmoderated AND all new comments then use some version of polling: ["unmoderated","newComm"]

modqueue

Activities requiring moderator review, such as reported things and items caught by the spam filter.

Use this if you only want the Bot to process reported/filtered Activities.

newSub

Get only Submissions that show up in /r/mySubreddit/new

Use this if you want the bot to process Submissions only when:

  • they are not initially filtered by Automoderator or
  • after they have been manually approved from modqueue

newComm

Get only new Comments

Use this if you want the bot to process Comments only when:

  • they are not initially filtered by Automoderator or
  • after they have been manually approved from modqueue

Valid values: modqueue, newComm, newSub, unmoderated

Loading...

Editor and Validator