Skip to main content

Class: JourneyStepBuilder

Defined in: packages/sdk/src/workspace-builder/journeys.ts:28

Extends​

  • WorkspaceBuilderResource

Constructors​

Constructor​

new JourneyStepBuilder(name, journey, order?, workflow?, description?): JourneyStepBuilder

Defined in: packages/sdk/src/workspace-builder/journeys.ts:31

Parameters​

name​

string

journey​

JourneyBuilder

order?​

number = 0

workflow?​

WorkflowBuilder

description?​

string = ''

Returns​

JourneyStepBuilder

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

connections​

readonly connections: StepConnectionDraft[] = []

Defined in: packages/sdk/src/workspace-builder/journeys.ts:29

description​

readonly description: string = ''

Defined in: packages/sdk/src/workspace-builder/journeys.ts:36

journey​

readonly journey: JourneyBuilder

Defined in: packages/sdk/src/workspace-builder/journeys.ts:33

name​

readonly name: string

Defined in: packages/sdk/src/workspace-builder/journeys.ts:32

order​

readonly order: number = 0

Defined in: packages/sdk/src/workspace-builder/journeys.ts:34

workflow?​

readonly optional workflow: WorkflowBuilder

Defined in: packages/sdk/src/workspace-builder/journeys.ts:35

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/journeys.ts:55

Parameters​

client​

GravityRailWorkspaceClient

Returns​

Promise<void>

Overrides​

WorkspaceBuilderResource.apply

connectsTo()​

connectsTo(child, condition?, required?, timeoutSeconds?): JourneyStepBuilder

Defined in: packages/sdk/src/workspace-builder/journeys.ts:41

Parameters​

child​

JourneyStepBuilder

condition?​

string

required?​

boolean = false

timeoutSeconds?​

number

Returns​

JourneyStepBuilder

matchKey()​

matchKey(): string | undefined

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

Returns​

string | undefined

Inherited from​

WorkspaceBuilderResource.matchKey

planLine()​

planLine(): string

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

Returns​

string

Overrides​

WorkspaceBuilderResource.planLine