Class TasklistApiClient

Description

The high-level client for the Tasklist GraphQL API

Example

Hierarchy

  • TasklistApiClient

Constructors

constructor

Properties

graphqlUrl userAgentString

Methods

claimTask completeTask deleteProcessInstance getAllTasks getCurrentUser getForm getHeaders getTask getTasks getVariable getVariables unclaimTask

Constructors

constructor

Properties

graphqlUrl

graphqlUrl: string

Private userAgentString

userAgentString: string

Methods

claimTask

completeTask

deleteProcessInstance

getAllTasks

getCurrentUser

getForm

Private getHeaders

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getTask

getTasks

  • Description

    Query Tasklist for a list of tasks. See the API documentation.

    Example

    const tasklist = new TasklistApiClient()

    async function getTasks() { 
      const res = await tasklist.getTasks({
        state: TaskState.CREATED
      }, ['id', 'name', 'processName'])
      console.log(res ? 'Nothing' : JSON.stringify(res.tasks, null, 2))
      return res
    }

    Returns

    Parameters

    • query: Partial<TaskQuery>
    • fields: TaskFields = defaultFields

      a list of fields to return in the query results

    Returns Promise<null | {
        tasks: Task[];
    }>

getVariable

getVariables

unclaimTask

Settings

Member Visibility

Theme

Generated using TypeDoc