ODMain class
We are still working the API Reference! This page might be incomplete or doesn't contain all details!
Overview
This is the main Open Ticket class. It contains all managers from the entire bot & has shortcuts to the event & logging system.
This class can't be overwritten or extended & is available as the global variable openticket!
Properties
actionsblacklistbuilderscheckersclientcodeconfigsconsolecooldownsdatabasesdebugdebugfiledefaultsenveventsflagshelpmenulanguageslivestatusoptionspanelspermissionspluginspostsprocessStartupDateprogressbarsquestionsreadyStartupDaterespondersrolessessionsstartscreenstatsticketstranscriptsverifybarsversions
Methods
Properties
actions class ➜ api.ODActionManager_Default
The manager that manages all actions or procedures in the bot. (e.g. ticket-creation, ticket-deletion, ticket-claiming, etc)
blacklist class ➜ api.ODBlacklistManager
The manager that manages the ticket blacklist. (people who are blacklisted can't create a ticket)
builders class ➜ api.ODBuilderManager_Default
The manager that manages all builders in the bot. (e.g. buttons, dropdowns, messages, modals, etc)
checkers class ➜ api.ODCheckerManager_Default
The manager that handles & executes all config checkers in the bot. (the code that checks if you have something wrong in your config)
client class ➜ api.ODClientManager_Default
The manager responsible for everything related to the client. (e.g. status, login, slash & text commands, etc)
code class ➜ api.ODCodeManager_Default
This manager is a place where you can put code that executes when the bot almost finishes the setup. (can be used for less important stuff that doesn't require an exact time-order)
configs class ➜ api.ODConfigManager_Default
The manager that manages & contains all the config files of the bot. (like config/general.json)
console class ➜ api.ODConsoleManager
The manager responsible for the console system. (logs, errors, etc)
cooldowns class ➜ api.ODCooldownManager_Default
The manager that contains all cooldowns of the bot. (e.g. ticket-cooldowns)
databases class ➜ api.ODDatabaseManager_Default
The manager that manages & contains all the databases of the bot. (like database/global.json)
debug class ➜ api.ODDebugger
The manager responsible for sending debug logs to the debug file. (otdebug.txt)
debugfile class ➜ api.ODDebugFileManager
The manager responsible for the debug file. (otdebug.txt)
defaults class ➜ api.ODDefaultsManager
This manager contains A LOD of booleans. With these switches, you can turn off "default behaviours" from the bot. This is used if you want to replace the default Open Ticket code.
env class ➜ api.ODEnvHelper
This manager manages all the variables in the ENV. It reads from both the .env file & the process.env. (these 2 will be combined)
events class ➜ api.ODEventManager_Default
The manager containing all Open Ticket events.
flags class ➜ api.ODFlagManager_Default
The manager that manages & checks all the console flags of the bot. (like --debug)
helpmenu class ➜ api.ODHelpMenuManager_Default
The manager that manages & renders the Open Ticket help menu. (not the embed, but the text)
languages class ➜ api.ODLanguageManager_Default
The manager that manages all languages & translations of the bot. (but not for plugins)
livestatus class ➜ api.ODLiveStatusManager_Default
The manager responsible for the livestatus system. (remote console logs)
options class ➜ api.ODOptionManager
The manager that manages all the data of options in the bot. (these are used for panels, ticket creation, reaction roles)
panels class ➜ api.ODPanelManager
The manager that manages all the data of panels in the bot. (panels contain the options)
permissions class ➜ api.ODPermissionManager_Default
The manager that contains all permissions for commands & actions in the bot. (use it to check if someone has admin perms or not)
plugins class ➜ api.ODPluginManager_Default
The manager that handles & executes all plugins in the bot.
posts class ➜ api.ODPostManager_Default
The manager that manages all posts (static discord channels) in the bot. (e.g. (transcript) logs, etc)
processStartupDate type ➜ Date
The timestamp that the (node.js) process of the bot started.
progressbars class ➜ api.ODProgressBarManager_Default
The manager responsible for progress bars in the console.
questions class ➜ api.ODQuestionManager
The manager that manages all the data of questions in the bot. (these are used in options & tickets)
readyStartupDate type ➜ null|Date
The timestamp that the bot finished loading and is ready for usage.
responders class ➜ api.ODResponderManager_Default
The manager that manages all responders in the bot. (e.g. commands, buttons, dropdowns, modals)
roles class ➜ api.ODRoleManager
The manager that manages all reaction roles in the bot. (here, you can add additional data to roles)
sessions class ➜ api.ODSessionManager_Default
The manager that manages all the data sessions of the bot. (it's a temporary database)
startscreen class ➜ api.ODStartScreenManager_Default
The manager responsible for the livestatus system. (remote console logs)
stats class ➜ api.ODStatsManager_Default
The manager that manages, saves & renders the Open Ticket statistics. (not the embed, but the text & database)
tickets class ➜ api.ODTicketManager
The manager that manages all tickets in the bot. (here, you can get & edit a lot of data from tickets)
transcripts class ➜ api.ODTranscriptManager_Default
The manager that manages the ticket transcripts. (both the history & compilers)
verifybars class ➜ api.ODVerifyBarManager_Default
The manager that manages all verify bars in the bot. (the ✅ ❌ buttons)
versions class ➜ api.ODVersionManager_Default
The manager that handles all versions in the bot.
Methods
constructor() function ➜ api.ODMain
(no description)
log() function ➜ void
Log a message to the console. But in the Open Ticket style :)
View Parameters (1)
message: class ➜api.ODConsoleMessage- Parameter Description Lorem Ipsum.
Defaults
We're still working on this part of the documentation!
Examples
We're still working on this part of the documentation!