Skip to main content

Class: NotificationRuleBuilder

Defined in: packages/sdk/src/workspace-builder/automation.ts:137

Extends​

Constructors​

Constructor​

new NotificationRuleBuilder(name, options?): NotificationRuleBuilder

Defined in: packages/sdk/src/workspace-builder/automation.ts:146

Parameters​

name​

string

options?​

AnyRecord = {}

Returns​

NotificationRuleBuilder

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

memberId​

readonly memberId: number

Defined in: packages/sdk/src/workspace-builder/automation.ts:139

name​

readonly name: string

Defined in: packages/sdk/src/workspace-builder/automation.ts:147

noticeType​

readonly noticeType: string

Defined in: packages/sdk/src/workspace-builder/automation.ts:138

notifyEmail​

readonly notifyEmail: boolean

Defined in: packages/sdk/src/workspace-builder/automation.ts:143

notifySms​

readonly notifySms: boolean

Defined in: packages/sdk/src/workspace-builder/automation.ts:142

notifyVoice​

readonly notifyVoice: boolean

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

prompt?​

readonly optional prompt: string

Defined in: packages/sdk/src/workspace-builder/automation.ts:141

workflow?​

readonly optional workflow: WorkflowBuilder

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

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/automation.ts:167

Parameters​

client​

GravityRailWorkspaceClient

Returns​

Promise<void>

Overrides​

WorkspaceBuilderResource.apply

matchKey()​

matchKey(): string | undefined

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

Returns​

string | undefined

Inherited from​

WorkspaceBuilderResource.matchKey

planLine()​

planLine(): string

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

Returns​

string

Overrides​

WorkspaceBuilderResource.planLine