Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace scheduledTasksService

Scheduled Tasks Service

Helper functions for scheduled tasks

import { scheduledTasksService } from '@oneblink/apps'

Index

Interfaces

Functions

Functions

completeTask

  • completeTask(options: { abortSignal?: AbortSignal; formsAppId: number; taskActionId: string; taskGroupInstanceId: undefined | string; taskId: string }): Promise<CompletedTask>

  • Complete the related Task for a specific Forms App

    Example

     
    const formsAppId = 1
    const taskId = 2
    const completedTask = await scheduledTasksService.completeTask({
      formsAppId,
      taskId,
    })

    Parameters

    • options: { abortSignal?: AbortSignal; formsAppId: number; taskActionId: string; taskGroupInstanceId: undefined | string; taskId: string }
      • Optional abortSignal?: AbortSignal
      • formsAppId: number
      • taskActionId: string
      • taskGroupInstanceId: undefined | string
      • taskId: string

    Returns Promise<CompletedTask>

deleteCompletedTask

  • deleteCompletedTask(id: string, abortSignal?: AbortSignal): Promise<void>

  • Delete the completed task record related to a Task for a specific Forms App

    Example

     
    const formsAppId = 1
    const taskId = 2
    const completedTask = await scheduledTasksService.completeTask({
      formsAppId,
      taskId,
    })
    await deleteCompletedTask(completedTask.id)

    Parameters

    • id: string
    • Optional abortSignal: AbortSignal

    Returns Promise<void>

getTaskGroupInstanceTasks

  • getTaskGroupInstanceTasks(__namedParameters: { abortSignal?: AbortSignal; date: string; formsAppId: number; taskGroupInstanceId: string }): Promise<{ taskGroup: TaskGroup; taskGroupInstance: TaskGroupInstance; taskResponses: TaskResponse[] }>

  • Obtain all of the tasks related to a Task Group Instances in a specific Forms App

    Example

     
    const formsAppId = 1
    const taskGroupInstanceId = 'abc123'
    const date = '2023-12-01'
    const tasks = await getTaskGroupInstanceTasks({
      formsAppId,
      taskGroupInstanceId,
      date,
    })

    Parameters

    • __namedParameters: { abortSignal?: AbortSignal; date: string; formsAppId: number; taskGroupInstanceId: string }
      • Optional abortSignal?: AbortSignal
      • date: string
      • formsAppId: number
      • taskGroupInstanceId: string

    Returns Promise<{ taskGroup: TaskGroup; taskGroupInstance: TaskGroupInstance; taskResponses: TaskResponse[] }>

getTaskGroupInstances

getTasksForFormsApp

  • getTasksForFormsApp(__namedParameters: { abortSignal?: AbortSignal; date: string; formsAppId: number }): Promise<{ taskResponses: TaskResponse[] }>

  • Obtain all of the related Tasks for a specific Forms App

    Example

     
    const formsAppId = 1
    const date = '2023-12-01'
    const tasks = await getTasksForFormsApp({ formsAppId, date })

    Parameters

    • __namedParameters: { abortSignal?: AbortSignal; date: string; formsAppId: number }
      • Optional abortSignal?: AbortSignal
      • date: string
      • formsAppId: number

    Returns Promise<{ taskResponses: TaskResponse[] }>