AutoModerationRule

Extends

ObjectToLower<APIAutoModerationRule>.DiscordBase<APIAutoModerationRule>

Constructors

new AutoModerationRule(client, data)

1
new AutoModerationRule(client: UsingClient, data: APIAutoModerationRule): AutoModerationRule

Parameters

Parameter	Type
`client`	`UsingClient`
`data`	`APIAutoModerationRule`

Returns

AutoModerationRule

Inherited from

ObjectToLower<APIAutoModerationRule>.constructor

Source

seyfert/src/structures/AutoModerationRule.ts:13

Properties

Property	Modifier	Type	Inherited from
`actions`	`public`	`Object`[]	`ObjectToLower.actions`
`client`	`readonly`	`UsingClient`	-
`creatorId`	`public`	`string`	`ObjectToLower.creatorId`
`enabled`	`public`	`boolean`	`ObjectToLower.enabled`
`eventType`	`public`	`MessageSend`	`ObjectToLower.eventType`
`exemptChannels`	`public`	`string`[]	`ObjectToLower.exemptChannels`
`exemptRoles`	`public`	`string`[]	`ObjectToLower.exemptRoles`
`guildId`	`public`	`string`	`ObjectToLower.guildId`
`id`	`public`	`string`	`ObjectToLower.id`
`name`	`public`	`string`	`ObjectToLower.name`
`triggerMetadata`	`public`	`Object`	`ObjectToLower.triggerMetadata`
`triggerMetadata.allowList`	`public`	`undefined` \| `string`[]	-
`triggerMetadata.keywordFilter`	`public`	`undefined` \| `string`[]	-
`triggerMetadata.mentionRaidProtectionEnabled`	`public`	`undefined` \| `boolean`	-
`triggerMetadata.mentionTotalLimit`	`public`	`undefined` \| `number`	-
`triggerMetadata.presets`	`public`	`undefined` \| `AutoModerationRuleKeywordPresetType`[]	-
`triggerMetadata.regexPatterns`	`public`	`undefined` \| `string`[]	-
`triggerType`	`public`	`AutoModerationRuleTriggerType`	`ObjectToLower.triggerType`

Accessors

createdAt

1
get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

createdTimestamp

1
get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

Methods

delete()

1
delete(reason?: string): Promise<never>

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<never>

Source

seyfert/src/structures/AutoModerationRule.ts:33

edit()

1
edit(body:     Object, reason?: string): Promise<AutoModerationRule>

Parameters

Parameter	Type
`body`	`Object`
`body.actions`	`undefined` \| `Object`[]
`body.enabled`?	`undefined` \| `boolean`
`body.eventType`?	`undefined` \| `MessageSend`
`body.exemptChannels`?	`undefined` \| `string`[]
`body.exemptRoles`?	`undefined` \| `string`[]
`body.name`?	`undefined` \| `string`
`body.triggerMetadata`?	`undefined` \| `Object`
`reason`?	`string`

Returns

Promise<AutoModerationRule>

Source

seyfert/src/structures/AutoModerationRule.ts:29

fetch()

1
fetch(): Promise<AutoModerationRule>

Returns

Promise<AutoModerationRule>

Source

seyfert/src/structures/AutoModerationRule.ts:25

fetchCreator()

1
fetchCreator(force: boolean): Promise<GuildMember>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<GuildMember>

Source

seyfert/src/structures/AutoModerationRule.ts:17

guild()

1
guild(force: boolean): Promise<Guild<"cached"> | Guild<"api">>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<Guild<"cached"> | Guild<"api">>

Source

seyfert/src/structures/AutoModerationRule.ts:21

methods()

1
static methods(__namedParameters:     Object): Object

Parameters

Parameter	Type
`__namedParameters`	`Object`
`__namedParameters.client`	`UsingClient`
`__namedParameters.guildId`	`string`

Returns

Object

Member	Type	Value
`create`	(`body`: `RESTPostAPIAutoModerationRuleJSONBody`) => `Promise`<`AutoModerationRule`>	-
`delete`	(`ruleId`: `string`, `reason`?: `string`) => `Promise`<`never`>	-
`edit`	(`ruleId`: `string`, `body`: `RESTPatchAPIAutoModerationRuleJSONBody`, `reason`?: `string`) => `Promise`<`AutoModerationRule`>	-
`fetch`	(`ruleId`: `string`) => `Promise`<`AutoModerationRule`>	-
`list`	() => `Promise`<`AutoModerationRule`[]>	-

Source

seyfert/src/structures/AutoModerationRule.ts:37