ODLiveStatusFileSource class

under construction

We are still working the API Reference! This page might be incomplete or doesn't contain all details!

Overview

This is the Open Ticket livestatus file source.

It is a LiveStatus source that will read the data from a local file.

This can be used for testing/extending the LiveStatus system!

View Source

Properties

• data
• id
• path

Methods

• constructor
• _change
• changed
• getMessages
• setData

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

inherited data array ➜ api.ODLiveStatusSourceData[]

The raw data of this source

View Source

---

inherited id class ➜ api.ODId

The id of this data.

View Source

---

path string ➜ string

The path to the source file

View Source

---

Methods

---

constructor() function ➜ api.ODLiveStatusFileSource

(no description)

View Parameters (2)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
• path: string ➜ string - 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

---

inherited getMessages() function ➜ Promise

Get all messages relevant to the bot based on some parameters.

View Parameters (1)

• main: class ➜ api.ODMain - Parameter Description Lorem Ipsum.

View Source

---

inherited setData() function ➜ void

Change the current data using this method!

View Parameters (1)

• data: array ➜ api.ODLiveStatusSourceData[] - 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!