Skip to main content

Class TaskListOptions

The TaskListOptions.

Assembly: Taskurai.dll​
Declaration
public class TaskListOptions

Properties​

IncludeIsolated​

Must tasks that run in isolation mode be included.

Declaration
public bool? IncludeIsolated { get; set; }

IsolationKey​

Isolation key to filter isolated tasks.

Declaration
public string IsolationKey { get; set; }

FilterIsolated​

Filter on isolated tasks (isolation key required).

Declaration
public bool? FilterIsolated { get; set; }

IncludeCompleted​

Include completed tasks.

Declaration
public bool? IncludeCompleted { get; set; }

IncludeArchived​

Must archived tasks be included.

Declaration
public bool? IncludeArchived { get; set; }

IncludeUnlisted​

Must tasks that are marked unlisted be included (default = false).

Declaration
public bool? IncludeUnlisted { get; set; }

IncludeChildTasks​

Include tasks that are child tasks (have a parentId). Default true.

Declaration
public bool? IncludeChildTasks { get; set; }

IncludeCronJobTasks​

Include tasks that originate from cron jobs (have a cronJobId). Default true.

Declaration
public bool? IncludeCronJobTasks { get; set; }

PageSizeHint​

Page size hint.

Declaration
public int? PageSizeHint { get; set; }

ContinuationToken​

Token to get the next page of results.

Declaration
public string ContinuationToken { get; set; }

ReturnTotalCount​

Must the total count be returned.

Declaration
public bool? ReturnTotalCount { get; set; }

ReturnCondensed​

Must the results be returned in condensed format.

Declaration
public bool? ReturnCondensed { get; set; }

General search term across multiple task fields. By default all keywords must match somewhere in the task.

Declaration
public string Search { get; set; }

SearchContainsAllKeywords​

When true, all keywords in the search term must match somewhere across the task fields. When false, the full search text is matched as a single phrase. Default true.

Declaration
public bool? SearchContainsAllKeywords { get; set; }

Id​

Filter on task id.

Declaration
public string Id { get; set; }

CorrelationId​

Filter on correlation id.

Declaration
public string CorrelationId { get; set; }

ParentId​

Filter on parent task id.

Declaration
public string ParentId { get; set; }

CronJobId​

Filter on cron job id.

Declaration
public string CronJobId { get; set; }

Command​

Filter on command.

Declaration
public string Command { get; set; }

ExternalId​

Filter on external id.

Declaration
public string ExternalId { get; set; }

ExternalAccountId​

Filter on external account id.

Declaration
public string ExternalAccountId { get; set; }

ExternalUserId​

Filter on external user id.

Declaration
public string ExternalUserId { get; set; }

Category​

Filter on category (Contains).

Declaration
public string Category { get; set; }

Subject​

Filter on subject (Contains).

Declaration
public string Subject { get; set; }

Statuses​

Filter on one or more task statuses.

Declaration
public IList<string> Statuses { get; set; }

StatusCode​

Filter on task status code.

Declaration
public int? StatusCode { get; set; }

HubName​

Filter on hub name.

Declaration
public string HubName { get; set; }

WorkerName​

Filter on worker name.

Declaration
public string WorkerName { get; set; }

Tags​

Filter on tags.

Declaration
public IDictionary<string, string> Tags { get; set; }

OrderBy​

Order by either use (fieldName:ASC) or (fieldName:DESC).

Declaration
public string OrderBy { get; set; }

IncludeSensitive​

Include sensitive task data in the response.

Declaration
public bool? IncludeSensitive { get; set; }