All write operations and cross-module reads the ModButtonPopup needs. Implemented by the parent (ModButtonUserRoot) so the popup remains presentational.

Methods¶

addContributor()¶

addContributor(subreddit, user): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:25

Adds a user as a contributor to a subreddit.

Parameters¶

subreddit¶

string

user¶

string

Returns¶

Promise<void>

addModerator()¶

addModerator(subreddit, user): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:29

Adds a user as a moderator of a subreddit.

Parameters¶

subreddit¶

string

user¶

string

Returns¶

Promise<void>

ban()¶

ban(params): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:12

Bans a user from a subreddit.

Parameters¶

params¶

banContext¶

string

banDuration¶

number

banMessage¶

string

note¶

string

subreddit¶

string

user¶

string

Returns¶

Promise<void>

flairUser()¶

flairUser(params): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:39

Sets a user’s flair in a subreddit.

Parameters¶

params¶

cssClass¶

string

subreddit¶

string

templateID¶

string

text¶

string

user¶

string

Returns¶

Promise<void>

getBanMacros()¶

getBanMacros(subreddit): Promise<BanMacros | null>

Defined in: extension/data/modules/modbutton/schema.ts:47

Loads ban macro defaults from the subreddit wiki config.

Parameters¶

subreddit¶

string

Returns¶

Promise<BanMacros | null>

muteUser()¶

muteUser(params): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:33

Mutes a user in a subreddit.

Parameters¶

params¶

duration¶

number

subreddit¶

string

user¶

string

Returns¶

Promise<void>

refreshCounters()¶

refreshCounters(): void

Defined in: extension/data/modules/modbutton/schema.ts:51

Refreshes notification counters after batch actions.

Returns¶

void

removeAllUserContent()¶

removeAllUserContent(subreddit, user): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:37

Removes all of a banned user’s content from a subreddit (used with permanent bans).

Parameters¶

subreddit¶

string

user¶

string

Returns¶

Promise<void>

removeContributor()¶

removeContributor(subreddit, user): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:27

Removes a user as a contributor from a subreddit.

Parameters¶

subreddit¶

string

user¶

string

Returns¶

Promise<void>

removeModerator()¶

removeModerator(subreddit, user): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:31

Removes a user as a moderator from a subreddit.

Parameters¶

subreddit¶

string

user¶

string

Returns¶

Promise<void>

sendModmail()¶

sendModmail(params): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:43

Sends a modmail message to a user.

Parameters¶

params¶

body¶

string

isAuthorHidden¶

boolean

subject¶

string

subreddit¶

string

to¶

string

Returns¶

Promise<void>

suggestBanNote()¶

suggestBanNote(subreddit, user): Promise<string | null>

Defined in: extension/data/modules/modbutton/schema.ts:49

Returns the latest ban note from usernotes for a user in a subreddit, or null if none.

Parameters¶

subreddit¶

string

user¶

string

Returns¶

Promise<string | null>

unban()¶

unban(subreddit, user): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:23

Unbans a user from a subreddit.

Parameters¶

subreddit¶

string

user¶

string

Returns¶

Promise<void>

unmuteUser()¶

unmuteUser(subreddit, user): Promise<void>

Defined in: extension/data/modules/modbutton/schema.ts:35

Unmutes a user in a subreddit.

Parameters¶

subreddit¶

string

user¶

string

Returns¶

Promise<void>

SubStatus¶

Defined in: extension/data/modules/modbutton/schema.ts:80

Per-subreddit status of the target user and current user’s permissions.

Properties¶

banned¶

banned: boolean

Defined in: extension/data/modules/modbutton/schema.ts:82

currentUserPermissions¶

currentUserPermissions: string[]

Defined in: extension/data/modules/modbutton/schema.ts:88

Current user’s mod permissions. Empty until loaded. ['all'] = full permissions.

daysLeft¶

daysLeft: number | null

Defined in: extension/data/modules/modbutton/schema.ts:83

isContributor¶

isContributor: boolean

Defined in: extension/data/modules/modbutton/schema.ts:85

isMod¶

isMod: boolean

Defined in: extension/data/modules/modbutton/schema.ts:84

isMuted¶

isMuted: boolean

Defined in: extension/data/modules/modbutton/schema.ts:86

loading¶

loading: boolean

Defined in: extension/data/modules/modbutton/schema.ts:81

Type Aliases¶

ActionKind¶

ActionKind = "ban" | "change ban" | "add submitter" | "remove submitter" | "mod" | "demod" | "mute" | "unmute"

Defined in: extension/data/modules/modbutton/schema.ts:69

The relationship actions the mod button can perform on a user.

Variables¶

DEFAULT_BAN_PRESETS¶

const DEFAULT_BAN_PRESETS: number[]

Defined in: extension/data/modules/modbutton/schema.ts:4

Default ban-duration preset buttons shown in the ban form (days).