📌 Types | Open Ticket Docs

📄️ ODCheckerFunctionCallback

This is the function used in the `ODCheckerFunction` class.

📄️ ODCheckerLocationTrace

This type is an array of strings & numbers which represents the location trace from the config checker. It's used to generate a path to the error (e.g. `"abc"."efg".1."something"`)

📄️ ODCheckerTranslationRegisterMessageIds_Default

This interface is a list of ids available in the `ODCheckerTranslationRegister_Default` class. It's used to generate typescript declarations for this class.

📄️ ODCheckerTranslationRegisterOtherIds_Default

This interface is a list of ids available in the `ODCheckerTranslationRegister_Default` class. It's used to generate typescript declarations for this class.

📄️ ODClientActivityStatus

Possible activity statuses for the bot.

📄️ ODClientActivityType

Possible activity types for the bot.

📄️ ODClientIntents

A list of intents required when inviting the bot.

📄️ ODClientPartials

A list of partials required for the bot to work. (`Message` & `Channel` are for receiving DM messages from uncached channels)

📄️ ODClientPermissions

A list of permissions required in the server that the bot is active in.

📄️ ODClientPriviligedIntents

A list of priviliged intents required to be enabled in the developer portal.

📄️ ODConsoleMessageTypes

This is a collection of all the default console message types within Open Ticket.

📄️ ODDefaultsBooleans

This type is a list of boolean defaults available in the `ODDefaultsManager` class. It's used to generate typescript declarations for this class.

📄️ ODDefaultsNumbers

This type is a list of number defaults available in the `ODDefaultsManager` class. It's used to generate typescript declarations for this class.

📄️ ODDefaultsStringArray

This type is a list of string[] defaults available in the `ODDefaultsManager` class. It's used to generate typescript declarations for this class.

📄️ ODDefaultsStrings

This type is a list of string defaults available in the `ODDefaultsManager` class. It's used to generate typescript declarations for this class.

📄️ ODDiscordIdType

A list of all available discord ID types. Used in the config checker.

📄️ ODDynamicStatRenderer

This callback will render a single dynamic statistic for a discord embed/message.

📄️ ODHelpMenuComponentRenderer

This is the callback of the help menu component renderer. It also contains information about how & where it is rendered.

📄️ ODHelpMenuRenderResult

This is the array returned when the help menu has been rendered successfully. It contains a list of pages, which contain categories by name & value (content).

📄️ ODInterfaceWithPartialProperty

This is a utility type to create an interface where some properties are optional!

📄️ ODJsonConfig_DefaultCmdPermissionSettingsType

This type is a collection of command permission settings for the "system"."permissions".... object in the `general.json` config!

📄️ ODJsonDatabaseStructure

This is the structure of how a JSON database file!

📄️ ODLanguageManagerTranslations_Default

This interface is a list of ids available in the `ODLanguageManager_Default` class. It's used to generate typescript declarations for this class.

📄️ ODLiveStatusColor

This is a collection of all the colors available within the LiveStatus system.

📄️ ODManagerAddCallback

This is a callback for the `onAdd` event in the `ODManager`

📄️ ODManagerCallback

This is a callback for the `onChange` and `onRemove` events in the `ODManager`

📄️ ODOptionalPromise

This is a simple type to represent a type as normal value or a promise value.

📄️ ODPermissionCalculationCallback

The callback of the permission calculation. (Used in `ODPermissionManager`)

📄️ ODPermissionEmbedType

This type contains all types available in the `opendiscord:no-permissions` embed.

📄️ ODPermissionScope

The scope in which a certain permission is active.

📄️ ODPermissionType

All available permission types/levels. Can be used in the `ODPermission` class.

📄️ ODProgressBarRenderFunc

This is the render function for an Open Ticket console progress bar.

📄️ ODProgressBarRenderer_DefaultSettingsLabel

All available label types for the default progress bar renderer

📄️ ODPromiseVoid

This is a simple type to represent a callback return value that could be a promise or not.

📄️ ODResponderTimeoutErrorCallback

This is the callback for the responder timeout function. It will be executed when something went wrong or the action takes too much time.

📄️ ODRoleUpdateMode

This is the mode of the reaction role option in the config.

📄️ ODSessionTimeoutCallback

This is the callback used for session timeout listeners.

📄️ ODSlashCommandInteractionCallback

Callback for the slash command interaction listener.

📄️ ODSlashCommandRegisteredResult

The result which will be returned when getting all (un)registered slash commands from the manager.

📄️ ODSlashCommandUpdateFunction

The function responsible for updating slash commands when they already exist.

📄️ ODStartScreenComponentRenderCallback

This is the render function of a startscreen component. It also sends the location of where the component is rendered.

📄️ ODStatRenderer

This callback will render a single statistic for a discord embed/message.

📄️ ODStatScopeSetMode

This type contains all valid methods for changing the value of a stat.

📄️ ODStatsManagerInitCallback

This callback can be used to execute something when the stats have been initiated. By default this is used to clear stats from users that left the server or tickets which don't exist anymore.