Class ClientTaskQueueService

A ClientTask describes a set of API actions the client has been requested to perform, usually encrypting some data with their private keys.

Hierarchy

Service<ClientTaskQueueApi>
- ClientTaskQueueService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClientTaskQueueService(environment: Environment, log?: Logger): ClientTaskQueueService

Inherited from Service<ClientTaskQueueApi>.constructor
- Defined in packages/sdk/src/services/service.ts:48
Parameters
- environment: Environment
- log: Logger = ...
Returns ClientTaskQueueService

Properties

Protected environment

environment: Environment

Protected keystoreAPIFactory

keystoreAPIFactory: KeystoreAPIFactory

Protected logger

logger: IFullLogger

Protected vaultAPIFactory

vaultAPIFactory: VaultAPIFactory

Methods

countOutstandingTasks

countOutstandingTasks(credentials: IVaultToken): Promise<IOutstandingClientTasks>

- Defined in packages/sdk/src/services/client-task-queue-service.ts:84
Count all tasks that have state either 'todo' or 'in_progress'. May make multiple API calls, depending on number of tasks.

Parameters
- credentials: IVaultToken
Returns Promise<IOutstandingClientTasks>

execute

execute(credentials: IVaultToken & IKeystoreToken & IKEK & IDEK, tasks: ClientTask[]): Promise<IClientTaskExecResult>

- Defined in packages/sdk/src/services/client-task-queue-service.ts:115
Execute the given ClientTasks, updating their state in the API. Currently, the only implemented task is 'update_item_share'.

ClientTask state is set to 'in_progress' once execution begins. Any tasks with state 'in_progress' or 'done' will raise an exception. Tasks with state 'failed' will be retried.

No tasks are initiated if any one of the tasks is unrecognized or cannot be started.

Parameters
- credentials: IVaultToken & IKeystoreToken & IKEK & IDEK
- tasks: ClientTask[]
  
  ClientTasks to be executed. Each must have state 'todo' or 'failed'.
Returns Promise<IClientTaskExecResult>

getAPI

getAPI(token: IVaultToken): ClientTaskQueueApi

Overrides Service.getAPI
- Defined in packages/sdk/src/services/client-task-queue-service.ts:35
Parameters
- token: IVaultToken
Returns ClientTaskQueueApi

list

list(credentials: IVaultToken, change_state?: boolean, states?: ClientTaskState[], target_id?: string, options?: IPageOptions): Promise<ClientTaskQueueResponse>

- Defined in packages/sdk/src/services/client-task-queue-service.ts:44
Parameters
- credentials: IVaultToken
- change_state: boolean = false
  
  If true, set the state of all tasks in the reponse to 'in_progress'
- states: ClientTaskState[] = ...
  
  Filter results by state.
- Optional target_id: string
  
  Filter results by target_id.
- Optional options: IPageOptions
Returns Promise<ClientTaskQueueResponse>

listAll

listAll(credentials: IVaultToken, change_state?: boolean, states?: ClientTaskState[], target_id?: string): Promise<ClientTask[]>

- Defined in packages/sdk/src/services/client-task-queue-service.ts:66
Parameters
- credentials: IVaultToken
- change_state: boolean = false
- states: ClientTaskState[] = ...
- Optional target_id: string
Returns Promise<ClientTask[]>

setLogger

setLogger(logger: Logger): void

Inherited from Service.setLogger
- Defined in packages/sdk/src/services/service.ts:56
Parameters
- logger: Logger
Returns void

Generated using TypeDoc