Skip to main content

ODClientManager_Default class

under construction

We are still working the API Reference! This page might be incomplete or doesn't contain all details!

Overview​

This is a special class that adds type definitions & typescript to the ODClientManager class. It doesn't add any extra features!

This default class is made for the global variable opendiscord.client!

View Source

Properties​

Methods​

Other​

Properties​

inherited activity class ➜ api.ODClientActivityManager​

The status manager is responsible for setting the bot status.

View Source

inherited client type ➜ discord.Client​

The discord.js discord.Client. Only use it when initiated!

View Source

inherited initiated boolean ➜ boolean​

Is the bot initiated?

View Source

inherited intents array ➜ api.ODClientIntents[]​

List of required bot intents. Add intents to this list using the onClientLoad event.

View Source

inherited loggedIn boolean ➜ boolean​

Is the bot logged in?

View Source

inherited mainServer type ➜ null|discord.Guild​

The main server of the bot. Provided by serverId in the config

View Source

inherited partials array ➜ api.ODClientPartials[]​

List of required bot partials. Add intents to this list using the onClientLoad event. ❌ Only use when neccessery!

View Source

inherited permissions array ➜ api.ODClientPermissions[]​

List of required bot permissions. Add permissions to this list using the onClientLoad event.

View Source

inherited privileges array ➜ api.ODClientPriviligedIntents[]​

List of required bot privileged intents. Add intents to this list using the onClientLoad event.

View Source

inherited ready boolean ➜ boolean​

Is the bot ready?

View Source

inherited readyListener type ➜ null|(() => Promise)​

(❌ DO NOT OVERWRITE ❌) Internal Open Ticket function to continue the startup when the client is ready!

View Source

inherited rest type ➜ discord.REST​

The discord.js REST client. Used for stuff that discord.js can't handle :)

View Source

slashCommands class ➜ api.ODSlashCommandManager_Default​

The slash command manager is responsible for all slash commands & their events inside the bot.

View Source

textCommands class ➜ api.ODTextCommandManager_Default​

The text command manager is responsible for all text commands & their events inside the bot.

View Source

Methods​

constructor() function ➜ api.ODClientManager_Default​

(no description)

View Parameters (1)
  • debug: class ➜ api.ODDebugger - Parameter Description Lorem Ipsum.

View Source

inherited checkBotInGuild() function ➜ boolean​

Check if the bot is in a specific guild

View Parameters (1)
  • guild: type ➜ discord.Guild - Parameter Description Lorem Ipsum.

View Source

inherited checkGuildPerms() function ➜ boolean​

Check if a specific guild has all required permissions (or Administrator)

View Parameters (1)
  • guild: type ➜ discord.Guild - Parameter Description Lorem Ipsum.

View Source

inherited fetchChannel() function ➜ Promise​

A simplified shortcut to get a discord.Channel :)

View Parameters (1)
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

inherited fetchGuild() function ➜ Promise​

A simplified shortcut to get a discord.Guild :)

View Parameters (1)
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

inherited fetchGuildCategoryChannel() function ➜ Promise​

A simplified shortcut to get a discord.CategoryChannel :)

View Parameters (2)
  • guildId: type ➜ string|discord.Guild - Parameter Description Lorem Ipsum.
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

inherited fetchGuildChannel() function ➜ Promise​

A simplified shortcut to get a discord.GuildBasedChannel :)

View Parameters (2)
  • guildId: type ➜ string|discord.Guild - Parameter Description Lorem Ipsum.
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

inherited fetchGuildChannelMessage() function ➜ Promise​

A simplified shortcut to get a discord.Message :)

View Parameters (3)

View Source

inherited fetchGuildMember() function ➜ Promise​

A simplified shortcut to get a discord.GuildMember :)

View Parameters (2)
  • guildId: type ➜ string|discord.Guild - Parameter Description Lorem Ipsum.
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

inherited fetchGuildRole() function ➜ Promise​

A simplified shortcut to get a discord.Role :)

View Parameters (2)
  • guildId: type ➜ string|discord.Guild - Parameter Description Lorem Ipsum.
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

inherited fetchGuildTextChannel() function ➜ Promise​

A simplified shortcut to get a discord.TextChannel :)

View Parameters (2)
  • guildId: type ➜ string|discord.Guild - Parameter Description Lorem Ipsum.
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

inherited fetchUser() function ➜ Promise​

A simplified shortcut to get a discord.User :)

View Parameters (1)
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

inherited getGuilds() function ➜ discord.Guild[]​

Get all servers the bot is part of.

View Source

inherited initClient() function ➜ void​

Initiate the client variable & add the intents & partials to the bot.

View Source

inherited login() function ➜ Promise​

Log-in with a discord auth token.

View Source

inherited sendUserDm() function ➜ Promise​

A simplified shortcut to send a DM to a user :)

View Parameters (2)

View Source

Defaults​

under construction

We're still working on this part of the documentation!

Examples​

under construction

We're still working on this part of the documentation!