ExpiringTaskCompletionPolicy
Hierarchy
- ExpiringTaskCompletionPolicy
Index
Constructors
Methods
Constructors
constructor
+ new ExpiringTaskCompletionPolicy(expireIn: number): ExpiringTaskCompletionPolicy
Creates an instance of ExpiringTaskCompletionPolicy.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
expireIn | number | 1 60 60 * 1000 | The amount of time in milliseconds after which Task will expire. |
Returns: ExpiringTaskCompletionPolicy
Methods
cancel
▸ cancel(taskList: TaskList, taskId: Guid): void
Cancels expiring policy for Task in TaskList.
Parameters:
| Name | Type | Description |
|---|---|---|
taskList | TaskList | TaskList instance on which policy is canceled. |
taskId | Guid | Identifier of a Task which policy should be canceled. |
Returns: void
implement
▸ implement(taskList: TaskList, taskId: Guid): void
Applies expiring policy to created Task in TaskList.
Parameters:
| Name | Type | Description |
|---|---|---|
taskList | TaskList | TaskList instance on which policy is applied. |
taskId | Guid | Task identifier to which policy should be applied. |
Returns: void
setExpirationDuration
▸ setExpirationDuration(expireIn: number): void
Sets expiration duration for policy.
Parameters:
| Name | Type | Description |
|---|---|---|
expireIn | number | The amount of time in milliseconds after which Task will expire. |
Returns: void