Class GlobalGuildBanManager

Manages guild bans in all servers.

Hierarchy

CacheableStructManager<string, MemberBan>
- GlobalGuildBanManager

Index

Constructors

Properties

Accessors

Methods

ban fetch fetchMany unban

Constructors

constructor

new GlobalGuildBanManager(client): GlobalGuildBanManager
Parameters
- client: Client
Returns GlobalGuildBanManager
Inherited from CacheableStructManager.constructor
- Defined in guilded.js/lib/managers/global/GlobalManager.ts:7

Properties

cache

cache: Collection<string, MemberBan> = ...

`Readonly` client

client: Client

Accessors

shouldCacheBan

get shouldCacheBan(): boolean
Returns whether bans should be cached.

Returns boolean
- Defined in guilded.js/lib/managers/global/GuildBanManager.ts:13

Methods

ban

ban(serverId, userId, reason?): Promise<MemberBan>
Bans a user from a server.
Parameters
- serverId: string
  
  The ID of the server.
- userId: string
  
  The ID of the user.
- Optional reason: string
Returns Promise<MemberBan>
A Promise that resolves with the newly created member ban.
- Defined in guilded.js/lib/managers/global/GuildBanManager.ts:73

fetch

fetch(serverId, userId, force?): Promise<MemberBan>
Fetches a member ban in a server.
Parameters
- serverId: string
  
  The ID of the server.
- userId: string
  
  The ID of the user.
- Optional force: boolean
  
  Whether to force fetch the ban even if it's cached.
Returns Promise<MemberBan>
A Promise that resolves with the fetched member ban.
- Defined in guilded.js/lib/managers/global/GuildBanManager.ts:25

fetchMany

fetchMany(serverId): Promise<Collection<string, MemberBan>>
Fetches all bans in a server.
Parameters
- serverId: string
  
  The ID of the server.
Returns Promise<Collection<string, MemberBan>>
A Promise that resolves with a collection of the fetched member bans.
- Defined in guilded.js/lib/managers/global/GuildBanManager.ts:49

unban

unban(serverId, userId, removeBanIfCached?): Promise<null | MemberBan>
Unbans a user from a server.
Parameters
- serverId: string
  
  The ID of the server.
- userId: string
  
  The ID of the user.
- removeBanIfCached: boolean = false
  
  Whether to remove the ban from the cache if it exists.
Returns Promise<null | MemberBan>
A Promise that resolves with the unbanned member ban or null if it isn't cached.
- Defined in guilded.js/lib/managers/global/GuildBanManager.ts:97

Generated using TypeDoc