ODFile class
We are still working the API Reference! This page might be incomplete or doesn't contain all details!
Overview
This is an Open Ticket file builder.
With this class, you can create a file to use in a message. The only difference with normal files is that this one can be edited by Open Ticket plugins!
This is possible by using "workers" or multiple functions that will be executed in priority order!
Properties
inherited allowCache boolean ➜ boolean
Cache a build or create it every time from scratch when this.build() gets executed.
inherited cache type ➜ null|api.ODFileBuildResult
The cache of this build.
inherited didCache boolean ➜ boolean
Did the build already got created/cached?
inherited id class ➜ api.ODId
The id of this data.
inherited workers class ➜ api.ODWorkerManager
The manager that has all workers of this implementation
Methods
constructor() function ➜ api.ODFile
(no description)
View Parameters (4)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.callback: type ➜api.ODWorkerCallback- Parameter Description Lorem Ipsum.priority: number ➜number- Parameter Description Lorem Ipsum.callbackId: type ➜api.ODValidId- Parameter Description Lorem Ipsum.
inherited protected _change() function ➜ void
Trigger an onChange() event in the parent ODManager of this class.
build() function ➜ Promise
Build this attachment & compile it for discord.js
View Parameters (2)
source: type ➜Source- Parameter Description Lorem Ipsum.params: type ➜Params- Parameter Description Lorem Ipsum.
inherited changed() function ➜ void
(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.
inherited resetCache() function ➜ api.ODFile
Reset the current cache
inherited setCacheMode() function ➜ api.ODFile
Set if caching is allowed
View Parameters (1)
allowed: boolean ➜boolean- 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!