Search
Preparing search index...
The search index is not available
Antfarm
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"lib/job/job"
Job
Class Job
Hierarchy
Job
FileJob
FolderJob
WebhookJob
Index
Constructors
constructor
Properties
e
id
life
Cycle
locally
Available
name
nest
tunnel
Methods
create
Life
Event
fail
get
Id
get
Life
Cycle
get
Name
get
Name
Proper
get
Nest
get
Tunnel
is
Locally
Available
set
Locally
Available
set
Name
set
Nest
set
Tunnel
to
String
transfer
Constructors
constructor
new
Job
(
e
:
Environment
, name
:
string
)
:
Job
Parameters
e:
Environment
name:
string
Returns
Job
Properties
Protected
e
e
:
Environment
Protected
id
id
:
string
Protected
life
Cycle
life
Cycle
:
LifeEvent
[]
Protected
locally
Available
locally
Available
:
boolean
Protected
name
name
:
string
Protected
nest
nest
:
Nest
Protected
tunnel
tunnel
:
Tunnel
Methods
Protected
create
Life
Event
create
Life
Event
(
verb
:
string
, start
:
string
, finish
:
string
)
:
void
Parameters
verb:
string
start:
string
finish:
string
Returns
void
fail
fail
(
reason
:
string
)
:
void
Parameters
reason:
string
Returns
void
get
Id
get
Id
(
)
:
string
Returns
string
get
Life
Cycle
get
Life
Cycle
(
)
:
Array
<
LifeEvent
>
Returns
Array
<
LifeEvent
>
get
Name
get
Name
(
)
:
string
Returns
string
get
Name
Proper
get
Name
Proper
(
)
:
string
Returns
string
get
Nest
get
Nest
(
)
:
Nest
Returns
Nest
get
Tunnel
get
Tunnel
(
)
:
Tunnel
Returns
Tunnel
is
Locally
Available
is
Locally
Available
(
)
:
boolean
Returns
boolean
set
Locally
Available
set
Locally
Available
(
available
:
boolean
)
:
void
Parameters
available:
boolean
Returns
void
set
Name
set
Name
(
name
:
string
)
:
void
Parameters
name:
string
Returns
void
set
Nest
set
Nest
(
nest
:
Nest
)
:
void
Parameters
nest:
Nest
Returns
void
set
Tunnel
set
Tunnel
(
tunnel
:
Tunnel
)
:
void
Parameters
tunnel:
Tunnel
Returns
void
to
String
to
String
(
)
:
string
Returns
string
transfer
transfer
(
tunnel
:
Tunnel
)
:
void
Transfer a job to another tunnel directly.
Parameters
tunnel:
Tunnel
Returns
void
Globals
"index"
"lib/antfarm"
"lib/environment/environment"
"lib/environment/life
Event"
"lib/environment/logger"
"lib/environment/options"
"lib/job/file"
"lib/job/file
Job"
"lib/job/folder
Job"
"lib/job/ftp
File
Job"
"lib/job/job"
"lib/job/webhook
Job"
"lib/nest/folder
Nest"
"lib/nest/ftp
Nest"
"lib/nest/nest"
"lib/nest/webhook
Nest"
"lib/tunnel/tunnel"
Job
constructor
e
id
life
Cycle
locally
Available
name
nest
tunnel
create
Life
Event
fail
get
Id
get
Life
Cycle
get
Name
get
Name
Proper
get
Nest
get
Tunnel
is
Locally
Available
set
Locally
Available
set
Name
set
Nest
set
Tunnel
to
String
transfer
shortid
Generated using
TypeDoc
Transfer a job to another tunnel directly.