Skip to main content

Class: TaskBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:74

Extends​

  • WorkspaceBuilderResource

Constructors​

Constructor​

new TaskBuilder(name, workflow, prompt?, start?, description?): TaskBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:78

Parameters​

name​

string

workflow​

WorkflowBuilder

prompt?​

string = ''

start?​

boolean = false

description?​

string = ''

Returns​

TaskBuilder

Overrides​

WorkspaceBuilderResource.constructor

Properties​

_created​

_created: boolean = false

Defined in: packages/sdk/src/workspace-builder/resource.ts:23

Inherited from​

WorkspaceBuilderResource._created

_existed​

_existed: boolean = false

Defined in: packages/sdk/src/workspace-builder/resource.ts:24

Inherited from​

WorkspaceBuilderResource._existed

_id?​

optional _id: number

Defined in: packages/sdk/src/workspace-builder/resource.ts:21

Inherited from​

WorkspaceBuilderResource._id

_uuid?​

optional _uuid: string

Defined in: packages/sdk/src/workspace-builder/resource.ts:22

Inherited from​

WorkspaceBuilderResource._uuid

description​

readonly description: string = ''

Defined in: packages/sdk/src/workspace-builder/workflows.ts:83

eventRules​

readonly eventRules: WorkspaceBuilderEventRule[] = []

Defined in: packages/sdk/src/workspace-builder/workflows.ts:76

name​

readonly name: string

Defined in: packages/sdk/src/workspace-builder/workflows.ts:79

prompt​

readonly prompt: string = ''

Defined in: packages/sdk/src/workspace-builder/workflows.ts:81

start​

readonly start: boolean = false

Defined in: packages/sdk/src/workspace-builder/workflows.ts:82

transitions​

readonly transitions: TaskTransition[] = []

Defined in: packages/sdk/src/workspace-builder/workflows.ts:75

workflow​

readonly workflow: WorkflowBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:80

Accessors​

id​

Get Signature​

get id(): number

Defined in: packages/sdk/src/workspace-builder/resource.ts:27

Server-assigned numeric id — available after apply() or adopt().

Returns​

number

Inherited from​

WorkspaceBuilderResource.id

uuid​

Get Signature​

get uuid(): string

Defined in: packages/sdk/src/workspace-builder/resource.ts:38

Server-assigned uuid — available after apply() or adopt().

Returns​

string

Inherited from​

WorkspaceBuilderResource.uuid

Methods​

adopt()​

adopt(existing): void

Defined in: packages/sdk/src/workspace-builder/resource.ts:55

Parameters​

existing​

AnyRecord

Returns​

void

Inherited from​

WorkspaceBuilderResource.adopt

apply()​

apply(client): Promise<void>

Defined in: packages/sdk/src/workspace-builder/workflows.ts:122

Parameters​

client​

GravityRailWorkspaceClient

Returns​

Promise<void>

Overrides​

WorkspaceBuilderResource.apply

initialMessage()​

initialMessage(message, suggestions?): TaskBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:111

Parameters​

message​

string

suggestions?​

string[]

Returns​

TaskBuilder

matchKey()​

matchKey(): string | undefined

Defined in: packages/sdk/src/workspace-builder/resource.ts:51

Returns​

string | undefined

Inherited from​

WorkspaceBuilderResource.matchKey

onEnter()​

onEnter(action, params?, name?): TaskBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:101

Parameters​

action​

string

params?​

AnyRecord = {}

name?​

string

Returns​

TaskBuilder

planLine()​

planLine(): string

Defined in: packages/sdk/src/workspace-builder/workflows.ts:118

Returns​

string

Overrides​

WorkspaceBuilderResource.planLine

transitionsTo()​

transitionsTo(child, when, autoNext?, required?): TaskBuilder

Defined in: packages/sdk/src/workspace-builder/workflows.ts:88

Parameters​

child​

TaskBuilder

when​

string

autoNext?​

boolean = false

required?​

boolean = false

Returns​

TaskBuilder