AutoMod

Represents the automod of a chatroom.

Extends

Base<T>

Type parameters

Type parameter
`T` extends `EventSubConnection`

Constructors

new AutoMod()

1
new AutoMod<T>(chatbot: ChatBot<T>, chatroom: ChatRoom<T>): AutoMod<T>

Creates a new instance of the automod.

Parameters

Parameter	Type	Description
`chatbot`	`ChatBot`<`T`>	The current instance of the chatbot.
`chatroom`	`ChatRoom`<`T`>	The chatroom where the automod is.

Returns

AutoMod<T>

Overrides

Base<T>.constructor

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:27

Properties

Property	Modifier	Type	Description	Inherited from
`chatbot`	`readonly`	`ChatBot`<`T`>	The current instance of the chatbot.	`Base.chatbot`
`chatroom`	`readonly`	`ChatRoom`<`T`>	The chatroom where the automod is.	-
`settings`	`readonly`	`AutoModSettingsManager`<`T`>	The settings manager of the automod.	-

Methods

setAggression()

1
setAggression(level: null | number): Promise<AutoModSettings<T>>

Sets the aggression level of the automod. This settings will disable the overall level.

Parameters

Parameter	Type	Description
`level`	`null` \| `number`	The aggression level of the automod. If null, it will be set to 0.

Returns

Promise<AutoModSettings<T>>

The new settings of the automod.

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:58

setBullying()

1
setBullying(level: null | number): Promise<AutoModSettings<T>>

Sets the bullying level of the automod. This settings will disable the overall level.

Parameters

Parameter	Type	Description
`level`	`null` \| `number`	The bullying level of the automod. If null, it will be set to 0.

Returns

Promise<AutoModSettings<T>>

The new settings of the automod.

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:91

setDisability()

1
setDisability(level: null | number): Promise<AutoModSettings<T>>

Sets the disability level of the automod. This settings will disable the overall level.

Parameters

Parameter	Type	Description
`level`	`null` \| `number`	The disability level of the automod. If null, it will be set to 0.

Returns

Promise<AutoModSettings<T>>

The new settings of the automod.

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:47

setMisogyny()

1
setMisogyny(level: null | number): Promise<AutoModSettings<T>>

Sets the misogyny level of the automod. This settings will disable the overall level.

Parameters

Parameter	Type	Description
`level`	`null` \| `number`	The misogyny level of the automod. If null, it will be set to 0.

Returns

Promise<AutoModSettings<T>>

The new settings of the automod.

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:80

setOverall()

1
setOverall(level: null | number): Promise<AutoModSettings<T>>

Sets the overall level of the automod. This setting will overwrite all the others.

Parameters

Parameter	Type	Description
`level`	`null` \| `number`	The overall level of the automod. If null, it will be set to 0.

Returns

Promise<AutoModSettings<T>>

The new settings of the automod.

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:38

setRacism()

1
setRacism(level: null | number): Promise<AutoModSettings<T>>

Sets the racism level of the automod. This settings will disable the overall level.

Parameters

Parameter	Type	Description
`level`	`null` \| `number`	The racism level of the automod. If null, it will be set to 0.

Returns

Promise<AutoModSettings<T>>

The new settings of the automod.

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:113

setSexBasedTerms()

1
setSexBasedTerms(level: null | number): Promise<AutoModSettings<T>>

Sets the level of sex based terms of the automod. This settings will disable the overall level.

Parameters

Parameter	Type	Description
`level`	`null` \| `number`	The level of sex based terms of the automod. If null, it will be set to 0.

Returns

Promise<AutoModSettings<T>>

The new settings of the automod.

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:124

setSexuality()

1
setSexuality(level: null | number): Promise<AutoModSettings<T>>

Sets the sexuality level of the automod. This settings will disable the overall level.

Parameters

Parameter	Type	Description
`level`	`null` \| `number`	The sexuality level of the automod. If null, it will be set to 0.

Returns

Promise<AutoModSettings<T>>

The new settings of the automod.

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:69

setSwearing()

1
setSwearing(level: null | number): Promise<AutoModSettings<T>>

Sets the harassment level of the automod. This settings will disable the overall level.

Parameters

Parameter	Type	Description
`level`	`null` \| `number`	The harassment level of the automod. If null, it will be set to 0.

Returns

Promise<AutoModSettings<T>>

The new settings of the automod.

Source

twitchfy/packages/chatbot/src/structures/AutoMod.ts:102