AutoModerationRuleManager

classe · Source

Manages API methods for auto moderation rules and stores their cache.

Extends: CachedManager

Properties

guild

guild: Guild

The guild this manager belongs to. Source

_cache

readonly · private

_cache: Collection

The private cache of items for this manager. Source

cache

abstract

cache: Collection

The cache of items for this manager. Source

holds

readonly · private

holds: function

The data structure belonging to this manager. Source

client

readonly

client: Client

The client that instantiated this Manager Source

Methods

resolve

resolve(autoModerationRule: AutoModerationRuleResolvable): AutoModerationRule

Resolves an AutoModerationRuleResolvable to an AutoModerationRule object. Parameters

Name	Type	Description
autoModerationRule	AutoModerationRuleResolvable	The AutoModerationRule resolvable to resolve

Returns: AutoModerationRuleSource

resolveId

resolveId(autoModerationRule: AutoModerationRuleResolvable): Snowflake

Resolves an AutoModerationRuleResolvable to a AutoModerationRule id. Parameters

Name	Type	Description
autoModerationRule	AutoModerationRuleResolvable	The AutoModerationRule resolvable to resolve

Returns: SnowflakeSource

create

async

async create(options: AutoModerationRuleCreateOptions): Promise<AutoModerationRule>

Creates a new auto moderation rule. Parameters

Name	Type	Description
options	AutoModerationRuleCreateOptions	Options for creating the auto moderation rule

Returns: Promise<AutoModerationRule>Source

edit

async

async edit(autoModerationRule: AutoModerationRuleResolvable, options: AutoModerationRuleEditOptions): Promise<AutoModerationRule>

Edits an auto moderation rule. Parameters

Name	Type	Description
autoModerationRule	AutoModerationRuleResolvable	The auto moderation rule to edit
options	AutoModerationRuleEditOptions	Options for editing the auto moderation rule

Returns: Promise<AutoModerationRule>Source

fetch

fetch(options?: AutoModerationRuleResolvable | FetchAutoModerationRuleOptions | FetchAutoModerationRulesOptions): Promise<(AutoModerationRule|Collection<Snowflake, AutoModerationRule>)>

Fetches auto moderation rules from Discord. Parameters

Name	Type	Description
options?	AutoModerationRuleResolvable | FetchAutoModerationRuleOptions | FetchAutoModerationRulesOptions	Options for fetching auto moderation rule(s)

Returns: Promise<(AutoModerationRule\|Collection<Snowflake, AutoModerationRule>)>

// Fetch all auto moderation rules from a guild without caching
guild.autoModerationRules.fetch({ cache: false })
  .then(console.log)
  .catch(console.error);

// Fetch a single auto moderation rule
guild.autoModerationRules.fetch('979083472868098119')
  .then(console.log)
  .catch(console.error);

// Fetch a single auto moderation rule without checking cache and without caching
guild.autoModerationRules.fetch({ autoModerationRule: '979083472868098119', cache: false, force: true })
  .then(console.log)
  .catch(console.error)

Source

delete

async

async delete(autoModerationRule: AutoModerationRuleResolvable, reason?: string): Promise<void>

Deletes an auto moderation rule. Parameters

Name	Type	Description
autoModerationRule	AutoModerationRuleResolvable	The auto moderation rule to delete
reason?	string	The reason for deleting the auto moderation rule

Returns: Promise<void>Source