Home Reference Source Test Repository

import Job from '@moqada/hubot-schedule-helper/src/Job.js'

public class | source

Job

Base Job class

Constructor Summary

Public Constructor
public	constructor(param: Object) Constructor

Member Summary

Public Members
public	cb: Function Callback
public	id: number Job id
public	job: Object \| null Instance of node-schedule Job
public	meta: Object Data for Job
public	pattern: string pattern
public	user: Object Object of serialized Hubot user

Method Summary

Public Methods
public	cancel() Cancel Job
public	exec(robot: Object) Execute Job
public	getEnvelope(): Object Get envelope for robot
public	getRoom(): string Get Hubot room id
public	serialize(): Object Serialize Job data
public	start(robot: Object) Start Job

Public Constructors

public constructor(param: Object) source

Constructor

Params:

Name	Type	Attribute	Description
param	Object		param
param.id	number		Job id
param.pattern	string		pattern string
param.user	Object		Hubot user
param.meta	Object		Data for Job
param.cb	Function	optional	callback

Public Members

public cb: Function source

Callback

public id: number source

Job id

public job: Object | null source

Instance of node-schedule Job

public meta: Object source

Data for Job

public pattern: string source

pattern

public user: Object source

Object of serialized Hubot user

Public Methods

public cancel() source

Cancel Job

public exec(robot: Object) source

Execute Job

Params:

Name	Type	Attribute	Description
robot	Object		Hubot robot

public getEnvelope(): Object source

Get envelope for robot

Return:

public getRoom(): string source

Get Hubot room id

Return:

public serialize(): Object source

Serialize Job data

Return:

public start(robot: Object) source

Start Job

Params:

Name	Type	Attribute	Description
robot	Object		Hubot robot