ODCheckerCustomStructure_UniqueIdArray 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 a unique id array (per source & scope)
Methods
Properties
inherited id class ➜ api.ODId
The id of this checker structure
inherited options interface ➜ api.ODCheckerArrayStructureOptions
The options for this checker structure
readonly scope string ➜ string
The scope to read unique ids (id needs to be unique in this scope)
readonly source string ➜ string
The source to read unique ids (generally the plugin name or openticket)
readonly usedScope type ➜ null|string
The scope to push unique ids when used in this array!
Methods
constructor() function ➜ api.ODCheckerCustomStructure_UniqueIdArray
(no description)
View Parameters (5)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.source: string ➜string- Parameter Description Lorem Ipsum.scope: string ➜string- Parameter Description Lorem Ipsum.usedScope: string ➜string- Parameter Description Lorem Ipsum.options: interface ➜api.ODCheckerArrayStructureOptions- 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: array ➜any[]- 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!