ODCheckerCustomStructure_DiscordId 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 custom checker structure.
This class extends a primitive config checker & adds another layer of checking in the custom function.
You can compare it to a blueprint for a specific checker.
This custom checker is made for discord ids (channel, user, role, ...)
Properties
readonly emptyAllowed boolean ➜ boolean
Is this id allowed to be empty
readonly extraOptions array ➜ string[]
Extra matches (value will also be valid when one of these options match)
inherited id class ➜ api.ODId
The id of this checker structure
inherited options interface ➜ api.ODCheckerStringStructureOptions
The options for this checker structure
readonly type type ➜ api.ODDiscordIdType
The type of id (used in rendering)
Methods
constructor() function ➜ api.ODCheckerCustomStructure_DiscordId
(no description)
View Parameters (5)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.type: type ➜api.ODDiscordIdType- Parameter Description Lorem Ipsum.emptyAllowed: boolean ➜boolean- Parameter Description Lorem Ipsum.extraOptions: array ➜string[]- Parameter Description Lorem Ipsum.options: interface ➜api.ODCheckerStringStructureOptions- Parameter Description Lorem Ipsum.
inherited check() function ➜ boolean
Check a variable if it matches all settings in this checker. This function is automatically executed by Open Ticket!
View Parameters (3)
checker: class ➜api.ODChecker- Parameter Description Lorem Ipsum.value: string ➜string- Parameter Description Lorem Ipsum.locationTrace: type ➜api.ODCheckerLocationTrace- 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!