Class Tasks

Create and assign tasks to get files translated or proofread by specific people. You can set the due dates, split words between people, and receive notifications about the changes and updates on tasks. Tasks are project-specific, so you’ll have to create them within a project.

Use API to create, modify, and delete specific tasks.

Hierarchy (view full)

CrowdinApi
- Tasks

Index

Constructors

constructor

Methods

addTask addTaskSettingsTemplate deleteTask deleteTaskSettingsTemplate editTask editTaskArchivedStatus editTaskSettingsTemplate exportTaskStrings getTask getTaskSettingsTemplate graphql listTasks listTaskSettingsTemplates listUserTasks withFetchAll

Constructors

constructor

new Tasks(credentials, config?): Tasks
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns Tasks
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:224

Methods

addTask

addTask(projectId, request): Promise<ResponseObject<Task>>
Parameters
- projectId: number
  project identifier
- request: CreateTaskRequest
  request body
Returns Promise<ResponseObject<Task>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.post
- Defined in tasks/index.ts:62

addTaskSettingsTemplate

addTaskSettingsTemplate(projectId, request): Promise<ResponseObject<TaskSettingsTemplate>>
Parameters
- projectId: number
  project identifier
- request: AddTaskSettingsTemplate
  request body
Returns Promise<ResponseObject<TaskSettingsTemplate>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.post
- Defined in tasks/index.ts:182

deleteTask

deleteTask(projectId, taskId): Promise<void>
Parameters
- projectId: number
  project identifier
- taskId: number
  task identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.delete
- Defined in tasks/index.ts:92

deleteTaskSettingsTemplate

deleteTaskSettingsTemplate(projectId, taskSettingsId): Promise<void>
Parameters
- projectId: number
  project identifier
- taskSettingsId: number
  task settings identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.delete
- Defined in tasks/index.ts:208

editTask

editTask(projectId, taskId, request): Promise<ResponseObject<Task>>
Parameters
- projectId: number
  project identifier
- taskId: number
  task identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Task>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.patch
- Defined in tasks/index.ts:103

editTaskArchivedStatus

editTaskArchivedStatus(projectId, taskId, request): Promise<ResponseObject<UserTask>>
Parameters
- projectId: number
  project identifier
- taskId: number
  task identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<UserTask>>
See
https://developer.crowdin.com/api/v2/#operation/api.user.tasks.patch
- Defined in tasks/index.ts:154

editTaskSettingsTemplate

editTaskSettingsTemplate(projectId, taskSettingsId, request): Promise<ResponseObject<TaskSettingsTemplate>>
Parameters
- projectId: number
  project identifier
- taskSettingsId: number
  task settings identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<TaskSettingsTemplate>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.patch
- Defined in tasks/index.ts:219

exportTaskStrings

exportTaskStrings(projectId, taskId): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- taskId: number
  task identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.exports.post
- Defined in tasks/index.ts:72

getTask

getTask(projectId, taskId): Promise<ResponseObject<Task>>
Parameters
- projectId: number
  project identifier
- taskId: number
  task identifier
Returns Promise<ResponseObject<Task>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.get
- Defined in tasks/index.ts:82

getTaskSettingsTemplate

getTaskSettingsTemplate(projectId, taskSettingsId): Promise<ResponseObject<TaskSettingsTemplate>>
Parameters
- projectId: number
  project identifier
- taskSettingsId: number
  task settings identifier
Returns Promise<ResponseObject<TaskSettingsTemplate>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.get
- Defined in tasks/index.ts:195

graphql

graphql<T>(req): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:258

listTasks

listTasks(projectId, options?): Promise<ResponseList<Task>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListTasksOptions
  optional parameters for the request
Returns Promise<ResponseList<Task>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.getMany
- Defined in tasks/index.ts:26
listTasks(projectId, limit?, offset?, status?): Promise<ResponseList<Task>>
Parameters
- projectId: number
  project identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
- Optionalstatus: TasksModel.Status
  list tasks with specified statuses. It can be one status or a list of comma-separated status values
Returns Promise<ResponseList<Task>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.getMany
- Defined in tasks/index.ts:35

listTaskSettingsTemplates

listTaskSettingsTemplates(projectId, options?): Promise<ResponseList<TaskSettingsTemplate>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<TaskSettingsTemplate>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.getMany
- Defined in tasks/index.ts:169

listUserTasks

listUserTasks(options?): Promise<ResponseList<UserTask>>
Parameters
- Optionaloptions: ListUserTasksOptions
  optional parameters for the request
Returns Promise<ResponseList<UserTask>>
See
https://developer.crowdin.com/api/v2/#operation/api.user.tasks.getMany
- Defined in tasks/index.ts:112
listUserTasks(limit?, offset?, status?, isArchived?): Promise<ResponseList<UserTask>>
Parameters
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
- Optionalstatus: TasksModel.Status
  list tasks with specified statuses. It can be one status or a list of comma-separated status values
- OptionalisArchived: BooleanInt
  list archived/not archived tasks for the authorized user. 1 - archived, 0 - not archived
Returns Promise<ResponseList<UserTask>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.user.tasks.getMany
- Defined in tasks/index.ts:121

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:313

Class Tasks

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Tasks

Methods

addTask

Parameters

Returns Promise<ResponseObject<Task>>

See

addTaskSettingsTemplate

Parameters

Returns Promise<ResponseObject<TaskSettingsTemplate>>

See

deleteTask

Parameters

Returns Promise<void>

See

deleteTaskSettingsTemplate

Parameters

Returns Promise<void>

See

editTask

Parameters

Returns Promise<ResponseObject<Task>>

See

editTaskArchivedStatus

Parameters

Returns Promise<ResponseObject<UserTask>>

See

editTaskSettingsTemplate

Parameters

Returns Promise<ResponseObject<TaskSettingsTemplate>>

See

exportTaskStrings

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

getTask

Parameters

Returns Promise<ResponseObject<Task>>

See

getTaskSettingsTemplate

Parameters

Returns Promise<ResponseObject<TaskSettingsTemplate>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Returns Promise<ResponseObject<T>>

listTasks

Parameters

Returns Promise<ResponseList<Task>>

See

Parameters

Returns Promise<ResponseList<Task>>

Deprecated

See

listTaskSettingsTemplates

Parameters

Returns Promise<ResponseList<TaskSettingsTemplate>>

See

listUserTasks

Parameters

Returns Promise<ResponseList<UserTask>>

See

Parameters

Returns Promise<ResponseList<UserTask>>

Deprecated

See

withFetchAll

Parameters

Returns this

`Optional`operationName?: string

`Optional`variables?: any