Managed Object - ConverterScheduledTaskManager

Property of
ConverterServerContent
See also
ConverterScheduledTaskInfo, ConverterScheduledTaskSpec, ScheduledTask, ScheduledTaskInfo, ScheduledTaskSpec
Since
Converter API 1.0


Managed Object Description

Deprecated. as of version 6 of Converter API. Converter as VC extension is no longer supported.

Object manager for scheduled tasks.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
ConverterCreateScheduledTask, ConverterGetScheduledTask, ConverterReconfigureScheduledTask

ConverterCreateScheduledTask

Creates a scheduled task.
Required Privileges
ScheduledTask.Create

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterScheduledTaskManager used to make the method call.
obj PManagedObjectReference

The managed object for which the scheduled task triggers an action. You can schedule tasks on any managed object.

Since Converter API 1.0
spec PConverterScheduledTaskSpec

The specification for the new scheduled task.

Since Converter API 1.0
PRequired privilege - see tooltip for details

Return Value

Type Description
ScheduledTaskInfoThe scheduled task created by the operation.

Faults

Type Description
DuplicateNameThrown if a scheduled task with the name already exists.
InvalidNameThrown if the scheduled task name is empty or too long.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterGetScheduledTask

Gets detailed information about a scheduled task.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterScheduledTaskManager used to make the method call.
task PManagedObjectReference
to a ScheduledTask

Scheduled task object.

Since Converter API 1.0
P Required privilege: task

Return Value

Type Description
ConverterScheduledTaskInfoInformation about the scheduled task.

Faults

Type Description
NotFoundThrown if the scheduled task could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterReconfigureScheduledTask

Reconfigures the scheduled task properties.
Required Privileges
ScheduledTask.Edit

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterScheduledTaskManager used to make the method call.
task PManagedObjectReference
to a ScheduledTask

Scheduled task object.

Since Converter API 1.0
spec PScheduledTaskSpec

The new specification for the scheduled task.

Since Converter API 1.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
DuplicateNameThrown if a scheduled task with the name already exists.
InvalidNameThrown if the scheduled task name is empty or too long.
InvalidStateThrown if the scheduled task is running.
NotFoundThrown if the scheduled task could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None