ODTranscriptCompiler 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 transcript compiler.

This class manages all functions to generate a transcript.

These functions should be defined when creating this compiler. Existing compilers already exist for html & text transcripts.

View Source

Properties

• compile
• id
• init
• ready

Methods

• constructor
• _change
• changed

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

compile type ➜ null|api.ODTranscriptCompilerCompileFunction

(no description)

View Source

---

inherited id class ➜ api.ODId

The id of this data.

View Source

---

init type ➜ null|api.ODTranscriptCompilerInitFunction

(no description)

View Source

---

ready type ➜ null|api.ODTranscriptCompilerReadyFunction

(no description)

View Source

---

Methods

---

constructor() function ➜ api.ODTranscriptCompiler

(no description)

View Parameters (4)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
• init: type ➜ api.ODTranscriptCompilerInitFunction - Parameter Description Lorem Ipsum.
• compile: type ➜ api.ODTranscriptCompilerCompileFunction - Parameter Description Lorem Ipsum.
• ready: type ➜ null|api.ODTranscriptCompilerReadyFunction - Parameter Description Lorem Ipsum.

View Source

---

inherited protected _change() function ➜ void

Trigger an onChange() event in the parent ODManager of this class.

View Source

---

inherited changed() function ➜ void

(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.

View Parameters (1)

• callback: type ➜ null|(() => void) - Parameter Description Lorem Ipsum.

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!