LogoAntiRaid

@antiraid-ext/utils/jobserverpoll

API reference for @antiraid-ext/utils/jobserverpoll

@antiraid-ext/utils/jobserverpoll

Types

PollOptions

Raw Type
type PollOptions = {
	jobId: string,

	timeout_nostatuschange: number?,

	callback: (dsP.Job) -> nil,

	poll_interval: number
}
PropTypeDescription
callback
(dsP.Job) -> nil
-
jobId
-
timeout_nostatuschange?
-
poll_interval
-

Functions

pollJobserverTillComplete

Function Signature
function pollJobserverTillComplete(ctx: Primitives.TemplateContext, opts: PollOptions) end

Arguments

ctx

Primitives.TemplateContext

opts

PollOptions

getIconOfState

Function Signature
function getIconOfState(state: string) -> string end

Arguments

state

string

Returns

ret1

string

_formatValue

Function Signature
function _formatValue(value: any) -> string end

Arguments

value

any

Returns

ret1

string

jobToEmbed

Function Signature
function jobToEmbed(ctx: Primitives.TemplateContext, job: dsP.Job, showStatuses: boolean?, showDownloadLink: boolean?) -> (apitypes.EmbedObject, {apitypes.ComponentObjects}) end

Arguments

ctx

Primitives.TemplateContext

job

dsP.Job

showStatuses

This field is optional and may not be specified

boolean?

This field is optional and may not be specified

boolean?

Returns

ret1

apitypes.EmbedObject

ret2

{apitypes.ComponentObjects}

Last updated on