Skip to main content

Class: FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:53

Extends​

Constructors​

Constructor​

new FormBuilder(name, slug?, options?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:62

Parameters​

name​

string

slug?​

string

options?​

AnyRecord = {}

Returns​

FormBuilder

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

collection​

readonly collection: boolean

Defined in: packages/sdk/src/workspace-builder/forms.ts:58

description​

readonly description: string

Defined in: packages/sdk/src/workspace-builder/forms.ts:56

eventRules​

readonly eventRules: WorkspaceBuilderEventRule[] = []

Defined in: packages/sdk/src/workspace-builder/forms.ts:60

fields​

readonly fields: SchemaField[] = []

Defined in: packages/sdk/src/workspace-builder/forms.ts:59

name​

readonly name: string

Defined in: packages/sdk/src/workspace-builder/forms.ts:54

prompt​

readonly prompt: string

Defined in: packages/sdk/src/workspace-builder/forms.ts:57

slug​

readonly slug: string

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

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

isImplicit​

Get Signature​

get isImplicit(): boolean

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

True for resources the server creates on our behalf (currently a journey's Start step). They are kept in the resource list so edges can reference them, but they are never created, printed, or counted.

Returns​

boolean

Inherited from​

WorkspaceBuilderResource.isImplicit

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

Parameters​

existing​

AnyRecord

Returns​

void

Inherited from​

WorkspaceBuilderResource.adopt

apply()​

apply(client): Promise<void>

Defined in: packages/sdk/src/workspace-builder/forms.ts:208

Parameters​

client​

GravityRailWorkspaceClient

Returns​

Promise<void>

Overrides​

WorkspaceBuilderResource.apply

arrayField()​

arrayField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:160

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

booleanField()​

booleanField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:124

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

dateField()​

dateField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:120

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

datetimeField()​

datetimeField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:148

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

emailField()​

emailField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:132

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

enumField()​

enumField(name, slug, options, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:105

Parameters​

name​

string

slug​

string

options​

any[]

settings?​

AnyRecord = {}

Returns​

FormBuilder

field()​

field(fieldType, name, slug, options?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:89

Parameters​

fieldType​

DataFieldType

name​

string

slug​

string

options?​
cel?​

string

choices?​

any[]

description?​

string

order?​

number

required?​

boolean

Returns​

FormBuilder

functionField()​

functionField(name, slug, cel, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:128

Parameters​

name​

string

slug​

string

cel​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

integerField()​

integerField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:144

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

longtextField()​

longtextField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:140

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

matchKey()​

matchKey(): string

Defined in: packages/sdk/src/workspace-builder/forms.ts:200

Returns​

string

Overrides​

WorkspaceBuilderResource.matchKey

numberField()​

numberField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:116

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

objectField()​

objectField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:164

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

onRecordCreated()​

onRecordCreated(action, params?, condition?, name?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:168

Parameters​

action​

string

params?​

AnyRecord = {}

condition?​

string

name?​

string

Returns​

FormBuilder

onRecordUpdated()​

onRecordUpdated(action, params?, condition?, name?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:184

Parameters​

action​

string

params?​

AnyRecord = {}

condition?​

string

name?​

string

Returns​

FormBuilder

phoneField()​

phoneField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:136

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

planLine()​

planLine(): string

Defined in: packages/sdk/src/workspace-builder/forms.ts:204

Returns​

string

Overrides​

WorkspaceBuilderResource.planLine

textField()​

textField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:112

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

timeOfDayField()​

timeOfDayField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:152

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder

usZipCodeField()​

usZipCodeField(name, slug, settings?): FormBuilder

Defined in: packages/sdk/src/workspace-builder/forms.ts:156

Parameters​

name​

string

slug​

string

settings?​

AnyRecord = {}

Returns​

FormBuilder