Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "lib/api-helper/misc/job/createJob"

Index

Enumerations

Interfaces

Functions

Functions

createJob

  • createJob<T>(details: JobDetails<T>, ctx: HandlerContext): Promise<object>
  • Create a Job in the backend with the provided name and tasks

    A job can execute any registered command in the same or other connected SDM:

    command: name of the CommandRegistration or the registration instance itself registration: optional name of the SDM this job should be send to; defaults to the current SDM parameters: Record type with all required parameters for this command name: optional name of the job description: optional description of the job used to display to the user in chat or web

    Type parameters

    • T: ParameterType

    Parameters

    Returns Promise<object>

Generated using TypeDoc