Skip to main content

ODSession 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 session.

It can be used to create 100% unique id's for usage in the bot. An id can also store additional data which isn't saved to the filesystem. You can almost compare it to the PHP session system.

View Source

Properties​

Methods​

Other​

Properties​

inherited id class ➜ api.ODId​

The id of this data.

View Source

sessions array ➜ api.ODSessionInstance[]​

An array of all the currently active session instances.

View Source

timeoutMinutes number ➜ number​

The default amount of minutes before a session automatically stops.

View Source

Methods​

constructor() function ➜ api.ODSession​

(no description)

View Parameters (2)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • intervalSeconds: number ➜ number - 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

data() function ➜ any​

Get the data of a session instance. Returns null when not found.

View Parameters (1)
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

onTimeout() function ➜ void​

Listen for a session timeout (default or custom)

View Parameters (1)

View Source

setTimeout() function ➜ boolean​

Change the global or session timeout minutes. Returns true when sucessful.

View Parameters (2)
  • min: number ➜ number - Parameter Description Lorem Ipsum.
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

start() function ➜ string​

Start a session instance with data. Returns the unique id required to access the session.

View Parameters (1)
  • data: type ➜ any - Parameter Description Lorem Ipsum.

View Source

stop() function ➜ boolean​

Stop & delete a session instance. Returns true when sucessful.

View Parameters (1)
  • id: string ➜ string - Parameter Description Lorem Ipsum.

View Source

stopAutoTimeout() function ➜ void​

Stop the global interval that automatically deletes timed-out sessions. (This action can't be reverted!)

View Source

update() function ➜ boolean​

Update the data of a session instance. Returns true when sucessful.

View Parameters (2)
  • id: string ➜ string - Parameter Description Lorem Ipsum.
  • data: type ➜ any - 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!