ODPermissionManager_Default class

under construction

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 ODPermissionManager class. It doesn't add any extra features!

This default class is made for the global variable opendiscord.permissions!

View Source

Properties

• defaultResult
• redirects

Methods

• constructor
• _change
• add
• changed
• exists
• get
• getAll
• getFiltered
• getIds
• getLength
• getPermissions
• getRegex
• hasPermissions
• loopAll
• onAdd
• onChange
• onRemove
• remove
• setCalculation
• setDefaultResult
• useDebug

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

inherited defaultResult interface ➜ api.ODPermissionResult

The result which is returned when no other permissions match. (member by default)

View Source

---

inherited redirects class ➜ api.ODManagerRedirectHelper

Handle all redirects in this ODManager

View Source

---

Methods

---

constructor() function ➜ api.ODPermissionManager_Default

(no description)

View Parameters (1)

• debug: class ➜ api.ODDebugger - 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 add() function ➜ boolean

Add data to the manager. The id will be fetched from the data class! You can optionally select to overwrite existing data!

View Parameters (2)

• data: type ➜ api.ODPermission|(api.ODPermission[]) - Parameter Description Lorem Ipsum.
• overwrite: boolean ➜ boolean - Parameter Description Lorem Ipsum.

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 exists() function ➜ boolean

Check if data that matches the ODId exists. Returns a boolean.

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

inherited get() function ➜ null|api.ODPermission

Get data that matches the ODId. Returns the found data.

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

inherited getAll() function ➜ api.ODPermission[]

Get all data inside this manager

View Source

---

inherited getFiltered() function ➜ api.ODPermission[]

Get all data that matches inside the filter function

View Parameters (1)

• predicate: function ➜ (value:api.ODPermission, index:number, array:api.ODPermission[]) => unknown - Parameter Description Lorem Ipsum.

View Source

---

inherited getIds() function ➜ api.ODId[]

Get a list of all the ids inside this manager

View Source

---

inherited getLength() function ➜ number

Get the length of the data inside this manager

View Source

---

inherited getPermissions() function ➜ Promise

Get an ODPermissionResult based on a few context factors. Use hasPermissions() to simplify the result.

View Parameters (4)

• user: type ➜ discord.User - Parameter Description Lorem Ipsum.
• channel: type ➜ null|discord.Channel - Parameter Description Lorem Ipsum.
• guild: type ➜ null|discord.Guild - Parameter Description Lorem Ipsum.
• settings: type ➜ null|api.ODPermissionSettings - Parameter Description Lorem Ipsum.

View Source

---

inherited getRegex() function ➜ api.ODPermission[]

Get all data that matches the regex

View Parameters (1)

• regex: type ➜ RegExp - Parameter Description Lorem Ipsum.

View Source

---

inherited hasPermissions() function ➜ boolean

Simplifies the ODPermissionResult returned from getPermissions() and returns a boolean to check if the user matches the required permissions.

View Parameters (2)

• minimum: type ➜ api.ODPermissionType - Parameter Description Lorem Ipsum.
• data: interface ➜ api.ODPermissionResult - Parameter Description Lorem Ipsum.

View Source

---

inherited loopAll() function ➜ Promise

Run an iterator over all data in this manager. This method also supports async-await behaviour!

View Parameters (1)

• cb: function ➜ (data:api.ODPermission, id:api.ODId) => api.ODPromiseVoid - Parameter Description Lorem Ipsum.

View Source

---

inherited onAdd() function ➜ void

Listen for when data is added to this manager.

View Parameters (1)

• callback: type ➜ api.ODManagerAddCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited onChange() function ➜ void

Listen for when data is changed in this manager.

View Parameters (1)

• callback: type ➜ api.ODManagerCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited onRemove() function ➜ void

Listen for when data is removed from this manager.

View Parameters (1)

• callback: type ➜ api.ODManagerCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited remove() function ➜ null|api.ODPermission

Remove data that matches the ODId. Returns the removed data.

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

inherited setCalculation() function ➜ void

Edit the permission calculation function in this manager.

View Parameters (1)

• calculation: type ➜ api.ODPermissionCalculationCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited setDefaultResult() function ➜ void

Edit the result which is returned when no other permissions match. (member by default)

View Parameters (1)

• result: interface ➜ api.ODPermissionResult - Parameter Description Lorem Ipsum.

View Source

---

inherited useDebug() function ➜ void

Use the Open Ticket debugger in this manager for logs

View Parameters (2)

• debug: class ➜ api.ODDebugger - Parameter Description Lorem Ipsum.
• debugname: string ➜ string - 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!