node-zendesk • Docs
node-zendesk / clients/job-monitor / export=
Class: export=
Constructors
new export=()
new export=(
options):export=
Parameters
• options: any
Returns
Defined in
clients/job-monitor.d.ts:3
Properties
client
client:
ZendeskClient
Defined in
clients/job-monitor.d.ts:4
Methods
checkJobStatus()
checkJobStatus(
jobID):Promise<object>
Checks the status of a job.
Parameters
• jobID: string
The ID of the job to monitor.
Returns
Promise<object>
- Promise resolving to the job status.
Defined in
clients/job-monitor.d.ts:10
monitorJobStatus()
monitorJobStatus(
jobID,interval?,maxAttempts?):Promise<object>
Continuously checks the status of a job using intervals and invokes a callback when the job status changes.
Parameters
• jobID: string
The ID of the job to monitor.
• interval?: number
The interval in milliseconds at which to check the job status.
• maxAttempts?: number
The maximum number of attempts to check the job status.
Returns
Promise<object>
- Promise resolving to the job result.
Defined in
clients/job-monitor.d.ts:18