Task Object

The Task object sends a task request to a Accruent Task Server task extension for execution, such as to send an email. For more information about the Accruent Task Server, see Meridian Task Server.

Task Object Methods

The Vault.Task object provides the methods described below.

ClosedReset Method

Clears the arguments of the current Task object.

Syntax

Reset()

Parameters

This method accepts no parameters.

Remarks

Reset the Task object before each task.

ClosedSet Method

Sets the value of the specified argument.

Syntax

Set(Argument As String, Value)
Parameters
Name Description

Argument

The name of the argument to set.

Value

The value to which to set the argument.

Remarks

The value of Argument is passed to the task extension on the Task Server as a parameter of the task to be performed. Each task extension defines its own arguments. Refer to the documentation of the task extension to find the appropriate argument names.

The argument names passed to Task Server extensions built with the Accruent .NET API are case-sensitive.

ClosedSubmit Method

Submits the current Task object to the Task Server.

Syntax

Submit(Type As String, [FSObject As IUnknown*], [StartAt], [Priority As Long = 0], [Server As String])
Parameters
Name Description

Type

The type of task that will be executed. This must be the ProgID of the task extension that will perform the task. The ProgID is a combination of the task extension project name and the class name used by the Visual Basic project that produced the task extension.

FSObject

Optional Document or Folder object. This parameter is only required if the task extension uses this information.

StartAt

Optional date value in Greenwich Mean Time (GMT) until which to delay the execution of the task.

Priority

Reserved for future use.

Server

Optional name of the computer that is running the Task Server service. The task will be executed on this computer. You can omit this parameter to use the default Task Server computer.

Remarks

The argument names passed to Task Server extensions built with the Accruent .NET API are case-sensitive.

2022 R2