TaskFilterParams | iland-sdk

Task Filter Params.

Hierarchy

TaskFilterParams

Implements

TaskFilterQueryParams

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new TaskFilterParams(taskFilterParams: TaskFilterParams): TaskFilterParams
new TaskFilterParams(taskFilterParamsJson: TaskFilterParamsJson): TaskFilterParams
new TaskFilterParams(entityUuid: string, entityType: EntityType, includeDescendantTasks?: undefined | false | true, synced?: undefined | false | true, username?: undefined | string, timestampAfter?: undefined | number, timestampBefore?: undefined | number, queryTimestamp?: undefined | number, offset?: undefined | number, limit?: undefined | number, order?: PagingOrder): TaskFilterParams

- Defined in model/task/task-filter-params.ts:12
Parameters
- taskFilterParams: TaskFilterParams
Returns TaskFilterParams
- Defined in model/task/task-filter-params.ts:14
Parameters
- taskFilterParamsJson: TaskFilterParamsJson
Returns TaskFilterParams
- Defined in model/task/task-filter-params.ts:15
Parameters
- entityUuid: string
- entityType: EntityType
- Optional includeDescendantTasks: undefined | false | true
- Optional synced: undefined | false | true
- Optional username: undefined | string
- Optional timestampAfter: undefined | number
- Optional timestampBefore: undefined | number
- Optional queryTimestamp: undefined | number
- Optional offset: undefined | number
- Optional limit: undefined | number
- Optional order: PagingOrder
Returns TaskFilterParams

Accessors

entityType

entityType:

Get entity type.

entityUuid

entityUuid:

Get entity uuid.

includeDescendantTasks

includeDescendantTasks:

Get include descendant tasks.

json

json:

Get the json representation of this class.

limit

limit:

Get limit.

offset

offset:

Get offset.

order

order:

Get order.

queryTimestamp

queryTimestamp:

Get query timestamp.

synced

synced:

Get synced.

timestampAfter

timestampAfter:

Get timestamp after.

timestampBefore

timestampBefore:

Get timestamp before.

username

username:

Get username.

Methods

getQueryParams

getQueryParams(): TaskFilterQueryParams

- Defined in model/task/task-filter-params.ts:246
Returns TaskFilterQueryParams

setIncludeDescendants

setIncludeDescendants(val?: undefined | false | true): TaskFilterParams

- Defined in model/task/task-filter-params.ts:89
Sets the filter property for including or excluding descendant tasks of the entity.

Parameters
- Optional val: undefined | false | true
Returns TaskFilterParams

setLimit

setLimit(val?: undefined | number): TaskFilterParams

- Defined in model/task/task-filter-params.ts:215
Sets the paging limit.

Parameters
- Optional val: undefined | number
Returns TaskFilterParams

setOffset

setOffset(val?: undefined | number): TaskFilterParams

- Defined in model/task/task-filter-params.ts:197
Sets the paging offset.

Parameters
- Optional val: undefined | number
Returns TaskFilterParams

setOrder

setOrder(val?: PagingOrder): TaskFilterParams

- Defined in model/task/task-filter-params.ts:233
Sets the paging order.

Parameters
- Optional val: PagingOrder
Returns TaskFilterParams

setQueryTimestamp

setQueryTimestamp(val?: undefined | number): TaskFilterParams

- Defined in model/task/task-filter-params.ts:179
Sets the query timestamp property. This property is useful for stable pagination over a query result set.

Parameters
- Optional val: undefined | number
Returns TaskFilterParams

setSynced

setSynced(val?: undefined | false | true): TaskFilterParams

- Defined in model/task/task-filter-params.ts:107
Sets the filter property for excluding tasks with a synced field that doesn't match the specified boolean value.

Parameters
- Optional val: undefined | false | true
Returns TaskFilterParams

setTimestampAfter

setTimestampAfter(val?: undefined | number): TaskFilterParams

- Defined in model/task/task-filter-params.ts:143
Sets the filter property for excluding tasks that do not have a timestamp after the specified epoch timestamp.

Parameters
- Optional val: undefined | number
Returns TaskFilterParams

setTimestampBefore

setTimestampBefore(val?: undefined | number): TaskFilterParams

- Defined in model/task/task-filter-params.ts:161
Sets the filter property for excluding tasks that do not have a timestamp before the specified epoch timestamp.

Parameters
- Optional val: undefined | number
Returns TaskFilterParams

setUsername

setUsername(val?: undefined | string): TaskFilterParams

- Defined in model/task/task-filter-params.ts:125
Sets the filter property for excluding tasks that were not initiated by the user with the specified username.

Parameters
- Optional val: undefined | string
Returns TaskFilterParams

toString

toString(): string

- Defined in model/task/task-filter-params.ts:266
Get the string representation of this class.

Returns string

Generated using TypeDoc