Skip to main content

Namespace: Actions

DBM.Actions

Classes​

Variables​

_letterEmojis​

• Const _letterEmojis: string[]


actionsLocation​

• Const actionsLocation: any = null


eventsLocation​

• Const eventsLocation: any = null


extensionsLocation​

• Const extensionsLocation: any = null


global​

• Const global: Object = {}


server​

• Const server: Object = {}


timeStamps​

• Const timeStamps: any[] = []

Functions​

addButtonToActionRowArray​

▸ addButtonToActionRowArray(array, rowText, buttonData, cache): void

Parameters​

NameType
arrayany
rowTextany
buttonDataany
cacheany

Returns​

void


addSelectToActionRowArray​

▸ addSelectToActionRowArray(array, rowText, selectData, cache): void

Parameters​

NameType
arrayany
rowTextany
selectDataany
cacheany

Returns​

void


addTextInputToActionRowArray​

▸ addTextInputToActionRowArray(array, rowText, textInput, cache): void

Parameters​

NameType
arrayany
rowTextany
textInputany
cacheany

Returns​

void


callListFunc​

▸ callListFunc(list, funcName, args): Promise<unknown>

Parameters​

NameType
listany
funcNameany
argsany

Returns​

Promise<unknown>


callNextAction​

▸ callNextAction(cache): void

Parameters​

NameType
cacheany

Returns​

void


checkConditions​

▸ checkConditions(guild, member, user, cmd): any

Parameters​

NameType
guildany
memberany
userany
cmdany

Returns​

any


checkModalSubmitResponses​

▸ checkModalSubmitResponses(interaction): void

Parameters​

NameType
interactionany

Returns​

void


checkPermissions​

▸ checkPermissions(member, permissions): any

Parameters​

NameType
memberany
permissionsany

Returns​

any


checkTemporaryInteractionResponses​

▸ checkTemporaryInteractionResponses(interaction): boolean

Parameters​

NameType
interactionany

Returns​

boolean


checkTimeRestriction​

▸ checkTimeRestriction(user, msgOrInteraction, cmd, returnTimeString?): any

Parameters​

NameTypeDefault value
useranyundefined
msgOrInteractionanyundefined
cmdanyundefined
returnTimeStringbooleanfalse

Returns​

any


clearAllTemporaryInteractions​

▸ clearAllTemporaryInteractions(messageId): void

Parameters​

NameType
messageIdany

Returns​

void


clearTemporaryInteraction​

▸ clearTemporaryInteraction(messageId, customId): void

Parameters​

NameType
messageIdany
customIdany

Returns​

void


convertTextToEmojis​

▸ convertTextToEmojis(text, useRegional?): string

Parameters​

NameTypeDefault value
textanyundefined
useRegionalbooleantrue

Returns​

string


displayError​

▸ displayError(data, cache, err): void

Parameters​

NameType
dataany
cacheany
errany

Returns​

void


endActions​

▸ endActions(cache): void

Parameters​

NameType
cacheany

Returns​

void


eval​

▸ eval(content, cache, logError?): any

Parameters​

NameTypeDefault value
contentanyundefined
cacheanyundefined
logErrorbooleantrue

Returns​

any


evalIfPossible​

▸ evalIfPossible(content, cache): any

Parameters​

NameType
contentany
cacheany

Returns​

any


evalMessage​

▸ evalMessage(content, cache): any

Parameters​

NameType
contentany
cacheany

Returns​

any


executeResults​

▸ executeResults(result, data, cache): void

Parameters​

NameType
resultany
dataany
cacheany

Returns​

void


executeSubActions​

▸ executeSubActions(actions, cache, callback?): boolean

Parameters​

NameTypeDefault value
actionsanyundefined
cacheanyundefined
callbackanynull

Returns​

boolean


executeSubActionsThenNextAction​

▸ executeSubActionsThenNextAction(actions, cache): any

Parameters​

NameType
actionsany
cacheany

Returns​

any


exists​

▸ exists(action): boolean

Parameters​

NameType
actionany

Returns​

boolean


findMemberOrUserFromID​

▸ findMemberOrUserFromID(id, server): Promise<User>

Parameters​

NameType
idany
serverany

Returns​

Promise<User>


findMemberOrUserFromName​

▸ findMemberOrUserFromName(name, server): Promise<any>

Parameters​

NameType
nameany
serverany

Returns​

Promise<any>


generateButton​

▸ generateButton(button, cache): Object

Parameters​

NameType
buttonany
cacheany

Returns​

Object

NameType
labelany
styleany
typestring

generateSelectMenu​

▸ generateSelectMenu(select, cache): Object

Parameters​

NameType
selectany
cacheany

Returns​

Object

NameType
customIdany
maxValuesnumber
minValuesnumber
optionsany
placeholderany
typestring

generateSubCache​

▸ generateSubCache(cache, actions): ActionsCache

Parameters​

NameType
cacheany
actionsany

Returns​

ActionsCache


generateTextInput​

▸ generateTextInput(textInput, defaultCustomId, cache): Object

Parameters​

NameType
textInputany
defaultCustomIdany
cacheany

Returns​

Object

NameType
customIdany
labelany
maxLengthnumber
minLengthnumber
placeholderany
requiredboolean
styleany
typestring

generateTimeString​

▸ generateTimeString(milliseconds): string

Parameters​

NameType
millisecondsany

Returns​

string


getActionVariable​

▸ getActionVariable(name, defaultValue): any

Parameters​

NameType
nameany
defaultValueany

Returns​

any


getAnyChannel​

▸ getAnyChannel(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getChannel​

▸ getChannel(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getChannelFromData​

▸ getChannelFromData(typeData, varNameData, cache): Promise<any>

Parameters​

NameType
typeDataany
varNameDataany
cacheany

Returns​

Promise<any>


getCustomEmoji​

▸ getCustomEmoji(nameOrId): GuildEmoji

Parameters​

NameType
nameOrIdany

Returns​

GuildEmoji


getDBM​

▸ getDBM(): typeof DBM

Returns​

typeof DBM


getDefaultResponseText​

▸ getDefaultResponseText(): any

Returns​

any


getErrorString​

▸ getErrorString(data, cache): string

Parameters​

NameType
dataany
cacheany

Returns​

string


getFlagEmoji​

▸ getFlagEmoji(flagName): any

Parameters​

NameType
flagNameany

Returns​

any


getInvalidButtonResponseText​

▸ getInvalidButtonResponseText(): any

Returns​

any


getInvalidCooldownResponse​

▸ getInvalidCooldownResponse(): any

Returns​

any


getInvalidPermissionsResponse​

▸ getInvalidPermissionsResponse(): any

Returns​

any


getInvalidSelectResponseText​

▸ getInvalidSelectResponseText(): any

Returns​

any


getInvalidUserResponse​

▸ getInvalidUserResponse(): any

Returns​

any


getList​

▸ getList(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getListFromData​

▸ getListFromData(typeData, varNameData, cache): Promise<any>

Parameters​

NameType
typeDataany
varNameDataany
cacheany

Returns​

Promise<any>


getLocalFile​

▸ getLocalFile(url): any

Parameters​

NameType
urlany

Returns​

any


getMember​

▸ getMember(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getMemberFromData​

▸ getMemberFromData(typeData, varNameData, cache): Promise<any>

Parameters​

NameType
typeDataany
varNameDataany
cacheany

Returns​

Promise<any>


getMessage​

▸ getMessage(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getMessageFromData​

▸ getMessageFromData(typeData, varNameData, cache): Promise<any>

Parameters​

NameType
typeDataany
varNameDataany
cacheany

Returns​

Promise<any>


getParameterFromInteraction​

▸ getParameterFromInteraction(interaction, name): any

Parameters​

NameType
interactionany
nameany

Returns​

any


getParameterFromParameterData​

▸ getParameterFromParameterData(option): any

Parameters​

NameType
optionany

Returns​

any


getRole​

▸ getRole(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getRoleFromData​

▸ getRoleFromData(typeData, varNameData, cache): Promise<any>

Parameters​

NameType
typeDataany
varNameDataany
cacheany

Returns​

Promise<any>


getSendReplyTarget​

▸ getSendReplyTarget(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getSendTarget​

▸ getSendTarget(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getSendTargetFromData​

▸ getSendTargetFromData(typeData, varNameData, cache): Promise<any>

Parameters​

NameType
typeDataany
varNameDataany
cacheany

Returns​

Promise<any>


getServer​

▸ getServer(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getServerFromData​

▸ getServerFromData(typeData, varNameData, cache): Promise<any>

Parameters​

NameType
typeDataany
varNameDataany
cacheany

Returns​

Promise<any>


getSlashParameter​

▸ getSlashParameter(interaction, name, defaultValue): any

Parameters​

NameType
interactionany
nameany
defaultValueany

Returns​

any


getTargetFromVariableOrParameter​

▸ getTargetFromVariableOrParameter(varType, varName, cache): any

Parameters​

NameType
varTypeany
varNameany
cacheany

Returns​

any


getVariable​

▸ getVariable(type, varName, cache): any

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

any


getVoiceChannel​

▸ getVoiceChannel(type, varName, cache): Promise<any>

Parameters​

NameType
typeany
varNameany
cacheany

Returns​

Promise<any>


getVoiceChannelFromData​

▸ getVoiceChannelFromData(typeData, varNameData, cache): Promise<any>

Parameters​

NameType
typeDataany
varNameDataany
cacheany

Returns​

Promise<any>


initMods​

▸ initMods(): void

Returns​

void


invokeActions​

▸ invokeActions(msg, actions, cmd?): void

Parameters​

NameTypeDefault value
msganyundefined
actionsanyundefined
cmdanynull

Returns​

void


invokeEvent​

▸ invokeEvent(event, server, temp): void

Parameters​

NameType
eventany
serverany
tempany

Returns​

void


invokeInteraction​

▸ invokeInteraction(interaction, actions, initialTempVars, meta?): void

Parameters​

NameTypeDefault value
interactionanyundefined
actionsanyundefined
initialTempVarsanyundefined
metaanynull

Returns​

void


modDirectories​

▸ modDirectories(): any[]

Returns​

any[]


preformActionsFromInteraction​

▸ preformActionsFromInteraction(interaction, cmd, meta?, initialTempVars?): void

Parameters​

NameTypeDefault value
interactionanyundefined
cmdanyundefined
metaanynull
initialTempVarsanynull

Returns​

void


preformActionsFromMessage​

▸ preformActionsFromMessage(msg, cmd): void

Parameters​

NameType
msgany
cmdany

Returns​

void


preformActionsFromSelectInteraction​

▸ preformActionsFromSelectInteraction(interaction, select, meta?, initialTempVars?): void

Parameters​

NameTypeDefault value
interactionanyundefined
selectanyundefined
metaanynull
initialTempVarsanynull

Returns​

void


registerModalSubmitResponses​

▸ registerModalSubmitResponses(interactionId, callback): void

Parameters​

NameType
interactionIdany
callbackany

Returns​

void


registerTemporaryInteraction​

▸ registerTemporaryInteraction(messageId, time, customId, userId, multi, interactionCallback): void

Parameters​

NameType
messageIdany
timeany
customIdany
userIdany
multiany
interactionCallbackany

Returns​

void


removeTemporaryInteraction​

▸ removeTemporaryInteraction(messageId, uniqueOrCustomId): void

Parameters​

NameType
messageIdany
uniqueOrCustomIdany

Returns​

void


storeValue​

▸ storeValue(value, type, varName, cache): void

Parameters​

NameType
valueany
typeany
varNameany
cacheany

Returns​

void