Skip to main content
@smokeballdev/smokeball-client-sdk

Interface: Api

Entry point for task to Smokeball.

Methods

all()

all(taskId): Promise<SubTask[]>
Gets the subTasks associated with the specified task id.

Parameters

taskId
string

Returns

Promise<SubTask[]> the subTasks associated with the specified task id.

Example


create()

create(request): Promise<SubTask>
Creates a new subTask for the specified task id and returns the newly created subTask.

Parameters

request
CreateSubTaskRequest the create request.

Returns

Promise<SubTask>

Example


delete()

delete(id, taskId): Promise<SubTask>
Marks subTask with the specified id and parent task id as deleted and returns the deleted subTask.

Parameters

id
string
taskId
string

Returns

Promise<SubTask>

Example


get()

get(id, taskId): Promise<SubTask>
Gets the subTask associated with the specified id and parent task id.

Parameters

id
string
taskId
string

Returns

Promise<SubTask> the subTask associated with the specified id and parent task id.

Example


update()

update(request): Promise<SubTask>
Updates a subTask with the specified id and returns the updated subTask.

Parameters

request
UpdateSubTaskRequest the update request.

Returns

Promise<SubTask>

Example