Skip to main content

ODClientManager class

under construction

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

Overview​

This is an Open Ticket client manager.

It is responsible for managing the discord.js client. Here, you can set the status, register slash commands and much more!

If you want, you can also listen for custom events on the ODClientManager.client variable (discord.Client)

View Source

Properties​

Methods​

Other​

Properties​

activity class ➜ api.ODClientActivityManager​

The status manager is responsible for setting the bot status.

View Source

client type ➜ discord.Client​

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

View Source

initiated boolean ➜ boolean​

Is the bot initiated?

View Source

intents array ➜ api.ODClientIntents[]​

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

View Source

loggedIn boolean ➜ boolean​

Is the bot logged in?

View Source

mainServer type ➜ null|discord.Guild​

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

View Source

partials array ➜ api.ODClientPartials[]​

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

View Source

permissions array ➜ api.ODClientPermissions[]​

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

View Source

privileges array ➜ api.ODClientPriviligedIntents[]​

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

View Source

ready boolean ➜ boolean​

Is the bot ready?

View Source

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

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

View Source

rest type ➜ discord.REST​

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

View Source

slashCommands class ➜ api.ODSlashCommandManager​

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

View Source

textCommands class ➜ api.ODTextCommandManager​

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

View Source

Methods​

constructor() function ➜ api.ODClientManager​

(no description)

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

View Source

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

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

fetchChannel() function ➜ Promise​

A simplified shortcut to get a discord.Channel :)

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

View Source

fetchGuild() function ➜ Promise​

A simplified shortcut to get a discord.Guild :)

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

View Source

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

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

fetchGuildChannelMessage() function ➜ Promise​

A simplified shortcut to get a discord.Message :)

View Parameters (3)

View Source

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

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

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

fetchUser() function ➜ Promise​

A simplified shortcut to get a discord.User :)

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

View Source

getGuilds() function ➜ discord.Guild[]​

Get all servers the bot is part of.

View Source

initClient() function ➜ void​

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

View Source

login() function ➜ Promise​

Log-in with a discord auth token.

View Source

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!