discord.js | AutoModerationRuleManager

Search...

AutoModerationRuleManager

export class AutoModerationRuleManager extends CachedManager<Snowflake, AutoModerationRule, AutoModerationRuleResolvable>

export class AutoModerationRuleManager extends CachedManager<Snowflake, AutoModerationRule, AutoModerationRuleResolvable>

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

Extends

CachedManager<Snowflake, AutoModerationRule, AutoModerationRuleResolvable>

Readonly

cache:Collection<Key, Holds>

The cache of items for this manager.

Inherited from DataManager

Readonly

client:Client

The client that instantiated this Manager

Inherited from BaseManager

guild:Guild

The guild this manager belongs to.

Readonly

holds:Constructable<Holds>

The data structure belonging to this manager.

Inherited from DataManager

create(options):Promise<AutoModerationRule>

Creates a new auto moderation rule.

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

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

Deletes an auto moderation rule.

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

edit(autoModerationRule, options):Promise<AutoModerationRule>

Edits an auto moderation rule.

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

fetch(options):Promise<AutoModerationRule>

Fetches auto moderation rules from Discord.

Example

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

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

Example

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

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

Example

// 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)

// 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)

Name	Type	Optional	Description
options	AutoModerationRuleResolvable \| FetchAutoModerationRuleOptions	No	Options for fetching auto moderation rule(s)

resolve(autoModerationRule):AutoModerationRule | null

Resolves an AutoModerationRuleResolvable to an AutoModerationRule object.

Name	Type	Optional	Description
autoModerationRule	AutoModerationRuleResolvable	No	The AutoModerationRule resolvable to resolve

resolveId(autoModerationRule):Snowflake | null

Resolves an AutoModerationRuleResolvable to a AutoModerationRule id.

Name	Type	Optional	Description
autoModerationRule	AutoModerationRuleResolvable	No	The AutoModerationRule resolvable to resolve

valueOf():Collection<Key, Holds>