ODJsonConfig_DefaultTranscripts class
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 ODJsonConfig class. It doesn't add any extra features!
This default class is made for the transcripts.json config!
Properties
data type ➜ {embedSettings:{customColor:discord.ColorResolvable, includeTicketStats:boolean, listAllParticipants:boolean}, general:{channel:string, enableActiveAdminDM:boolean, enableChannel:boolean, enableCreatorDM:boolean, enabled:boolean, enableEveryAdminDM:boolean, enableParticipantDM:boolean, mode:"text"|"html"}, htmlTranscriptStyle:{background:{backgroundColor:string, backgroundImage:string, enableCustomBackground:boolean}, favicon:{enableCustomFavicon:boolean, imageUrl:string}, header:{backgroundColor:string, decoColor:string, enableCustomHeader:boolean, textColor:string}, stats:{backgroundColor:string, enableCustomStats:false, hideBackgroundColor:string, hideTextColor:string, keyTextColor:string, valueTextColor:string}}, textTranscriptStyle:{customFileName:string, fileMode:"custom"|"user-name"|"user-id"|"channel-name"|"channel-id", includeBotMessages:boolean, includeEmbeds:boolean, includeFiles:boolean, includeIds:boolean, includeStats:boolean, layout:"normal"|"simple"|"detailed"}}
An object/array of the entire config file! Variables inside it can be edited while the bot is running!
inherited file string ➜ string
The name of the file with extension.
inherited id class ➜ api.ODId
The id of this data.
inherited path string ➜ string
The path to the file relative to the main directory.
Methods
constructor() function ➜ api.ODJsonConfig_DefaultTranscripts
(no description)
View Parameters (3)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.file: string ➜string- Parameter Description Lorem Ipsum.customPath: string ➜string- Parameter Description Lorem Ipsum.
inherited protected _change() function ➜ void
Trigger an onChange() event in the parent ODManager of this class.
inherited changed() function ➜ void
(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.
inherited init() function ➜ api.ODPromiseVoid
Init the config.
inherited onReload() function ➜ void
Listen for a reload of this JSON file!
View Parameters (1)
cb: type ➜Function- Parameter Description Lorem Ipsum.
inherited reload() function ➜ void
Reload the JSON file. Be aware that this doesn't update classes that used individual parts of the config data!
inherited removeAllReloadListeners() function ➜ void
Remove all reload listeners. Not recommended!
Defaults
We're still working on this part of the documentation!
Examples
We're still working on this part of the documentation!