AddScheduledTask Method

Description

Adds a scheduled task to a task queue. The "ApplicationTaskInfo" object must contain the ID of the task queue to which the task is to be added.

Syntax

Visual Basic
Public Function AddScheduledTask( _ ByVal QueueID As String, _ ByVal RestoreToWaitingTimeoutInMinutes As Long, _ ByVal TaskType As String, _ ByVal TaskData() As Byte, _ ByVal ActivationTimestamp As Timestamp _ ) As String

Visual Basic

Public Function AddScheduledTask( _
   ByVal QueueID As String, _
   ByVal RestoreToWaitingTimeoutInMinutes As Long, _
   ByVal TaskType As String, _
   ByVal TaskData() As Byte, _
   ByVal ActivationTimestamp As Timestamp _
) As String

Parameters

QueueID: The ID of the task queue to which the new task is to be added.
RestoreToWaitingTimeoutInMinutes: The timeout in minutes after which the task is set to the waiting state.
TaskType: The task type. This can be used as an identifier for how the task data should be interpreted.
TaskData: The payload of the task.
ActivationTimestamp: The earliest time the task can be reserved for processing.

Remarks

Supported in M-Files 19.7.8028.5 and later.

This method is available only if M-Files API is used in the server interface mode.