JobService In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:03:10 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:03:10

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Jobs.Version1.IJobService>() and is defined in Telligent.Evolution.Platform.dll

Properties

Name	Type	Description	Default	Options
ExecutionContext	`[[JobContext In-Process API Supplementary Type\|JobContext]]`

Methods

JobInfo Get(Guid id);

This method will return the scheduled job details.

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required

Return Type

JobInfo

bool Reschedule(Guid id, DateTime utcTime);

This method will reschedule an existing the job

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required
utcTime	`DateTime`	Utc Time	Required

Return Type

bool

bool Reschedule(Guid jobId, Guid clientId, DateTime utcTime);

This method will reschedule an existing the job

Parameters

Name	Type	Description	Required
jobId	`Guid`	Job Id	Required
clientId	`Guid`	Client Id	Required
utcTime	`DateTime`	Utc Time	Required

Return Type

bool

void Schedule<T>(Dictionary<string,string> data = null);

This method will schedule the job type T to be run as soon as possible. Any data the job needs to execute should be passed into the data parameter. That data will be provided to the job again when it executes. If no data is needed, null is acceptable.

Parameters

Name	Type	Description	Required	Default	Options
data	`Dictionary<string,string>`	Data	Optional

void Schedule<T>(DateTime utcTime, Dictionary<string,string> data = null);

This method will schedule the job type T to be run after the specified utcTime. The time should be specified as universal time (UTC). Any data the job needs to execute should be passed into the data parameter. That data will be provided to the job again when it executes. If no data is needed, null is acceptable.

Parameters

Name	Type	Description	Required	Default	Options
utcTime	`DateTime`	Utc Time	Required
data	`Dictionary<string,string>`	Data	Optional

void Schedule(Type jobType, DateTime utcTime, Dictionary<string,string> data = null);

This method will schedule the job type jobType to be run after the specified utcTime. The time should be specified as universal time (UTC). Any data the job needs to execute should be passed into the data parameter. That data will be provided to the job again when it executes. If no data is needed, null is acceptable.

Parameters

Name	Type	Description	Required
jobType	`Type`	Job Type	Required
utcTime	`DateTime`	Utc Time	Required
data	`Dictionary<string,string>`	Data	Optional

JobInfo Schedule<T>(Guid id, DateTime utcTime, Dictionary<string,string> data = null);

Parameters

Name	Type	Description	Required
id	`Guid`	Id	Required
utcTime	`DateTime`	Utc Time	Required
data	`Dictionary<string,string>`	Data	Optional

Return Type

JobInfo

JobInfo Schedule(Type jobType, Guid id, DateTime utcTime, Dictionary<string,string> data = null);

Parameters

Name	Type	Description	Required
jobType	`Type`	Job Type	Required
id	`Guid`	Id	Required
utcTime	`DateTime`	Utc Time	Required
data	`Dictionary<string,string>`	Data	Optional

Return Type

JobInfo