Class: RequiredParser
The require tag will attempt to convert the given parameter into a channel, user
or role, using name or Id. If the user running the tag is not in the targeted
channel or doesn't have the targeted role or their id isn't same as targeted user's id, the tag will stop processing and
it will send the response if one is given. Multiple role, user or channel
requirements can be given, and should be split by a ,
.
Aliases: allowlist, whitelist
Examples
Developers need to add the check themselves.
Extends
BaseParser
Implements
IParser
Constructors
new RequiredParser()
new RequiredParser(): RequiredParser
Returns
Overrides
BaseParser.constructor
Defined in
tagscript-plugin-discord/src/lib/Parsers/AllowDeny.ts:40
Properties
acceptedNames
protected
acceptedNames: string
[]
Inherited from
BaseParser.acceptedNames
Defined in
tagscript/dist/index.d.ts:381
requiredParameter
protected
requiredParameter: boolean
Inherited from
BaseParser.requiredParameter
Defined in
tagscript/dist/index.d.ts:382
requiredPayload
protected
requiredPayload: boolean
Inherited from
BaseParser.requiredPayload
Defined in
tagscript/dist/index.d.ts:383
Methods
parse()
parse(ctx
): null
| ""
Parses the given tag.
Parameters
ctx
Context
The context of the tag.
Returns
null
| ""
Implementation of
IParser.parse
Defined in
tagscript-plugin-discord/src/lib/Parsers/AllowDeny.ts:44
toJSON()
toJSON(): object
Returns
object
acceptedNames
acceptedNames: string
[]
requiredParameter
requiredParameter: boolean
requiredPayload
requiredPayload: boolean
Inherited from
BaseParser.toJSON
Defined in
tagscript/dist/index.d.ts:386
willAccept()
willAccept(ctx
): boolean
Parameters
ctx
Context
Returns
boolean
Implementation of
IParser.willAccept
Inherited from
BaseParser.willAccept
Defined in
tagscript/dist/index.d.ts:385