Skip to main content

Class: JourneyBuilder

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

Extends​

  • WorkspaceBuilderResource

Constructors​

Constructor​

new JourneyBuilder(name, options?): JourneyBuilder

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

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

JourneyBuilder

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

goals​

readonly goals: JourneyGoalDraft[] = []

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

name​

readonly name: string

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

steps​

readonly steps: JourneyStepBuilder[] = []

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

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:114

Parameters​

client​

GravityRailWorkspaceClient

Returns​

Promise<void>

Overrides​

WorkspaceBuilderResource.apply

goal()​

goal(name, options?): JourneyBuilder

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

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

JourneyBuilder

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:107

Returns​

string

Overrides​

WorkspaceBuilderResource.planLine

step()​

step(name, options?): JourneyStepBuilder

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

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

JourneyStepBuilder