Interface ZBGrpc

Hierarchy

GrpcClient
- ZBGrpc

Index

Properties

Properties

activateJobsStream

activateJobsStream: any

channelClosed

channelClosed: boolean = false

client

client: Client

completeJobSync

completeJobSync: any

connected

connected: boolean = false

host

host: string

Optional longPoll

longPoll: MaybeTimeDuration

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ZBGrpc

Inherited from GrpcClient.addListener
- Defined in node_modules/@types/node/ts4.8/events.d.ts:57
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ZBGrpc

broadcastSignalSync

broadcastSignalSync(signal: BroadcastSignalRequest): Promise<BroadcastSignalResponse>

- Defined in src/lib/interfaces-1.0.ts:471
Parameters
- signal: BroadcastSignalRequest
Returns Promise<BroadcastSignalResponse>

cancelProcessInstanceSync

cancelProcessInstanceSync(processInstanceKey: { processInstanceKey: string | number }): Promise<void>

- Defined in src/lib/interfaces-1.0.ts:463
Parameters
- processInstanceKey: { processInstanceKey: string | number }
  - processInstanceKey: string | number
Returns Promise<void>

close

close(timeout?: number): Promise<null>

Inherited from GrpcClient.close
- Defined in src/lib/GrpcClient.ts:415
Parameters
- timeout: number = 5000
Returns Promise<null>

createProcessInstanceSync

createProcessInstanceSync(createProcessInstanceRequest: CreateProcessInstanceRequest): Promise<CreateProcessInstanceResponse>

- Defined in src/lib/interfaces-1.0.ts:457
Parameters
- createProcessInstanceRequest: CreateProcessInstanceRequest
Returns Promise<CreateProcessInstanceResponse>

createProcessInstanceWithResultSync

createProcessInstanceWithResultSync<Result>(createProcessInstanceWithResultRequest: CreateProcessInstanceWithResultRequest): Promise<CreateProcessInstanceWithResultResponse<Result>>

- Defined in src/lib/interfaces-1.0.ts:460
Type parameters
- Result
Parameters
- createProcessInstanceWithResultRequest: CreateProcessInstanceWithResultRequest
Returns Promise<CreateProcessInstanceWithResultResponse<Result>>

deployProcessSync

deployProcessSync(processes: { processes: ProcessRequestObject[] }): Promise<DeployProcessResponse>

- Defined in src/lib/interfaces-1.0.ts:447
Parameters
- processes: { processes: ProcessRequestObject[] }
  - processes: ProcessRequestObject[]
Returns Promise<DeployProcessResponse>

deployResourceSync

deployResourceSync<T>(resource: DeployResourceRequest): Promise<DeployResourceResponse<T>>

- Defined in src/lib/interfaces-1.0.ts:450
Type parameters
- T
Parameters
- resource: DeployResourceRequest
Returns Promise<DeployResourceResponse<T>>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from GrpcClient.emit
- Defined in node_modules/@types/node/ts4.8/events.d.ts:67
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

evaluateDecisionSync

evaluateDecisionSync(evaluateDecisionRequest: EvaluateDecisionRequest): Promise<EvaluateDecisionResponse>

- Defined in src/lib/interfaces-1.0.ts:453
Parameters
- evaluateDecisionRequest: EvaluateDecisionRequest
Returns Promise<EvaluateDecisionResponse>

eventNames

eventNames(): (string | symbol)[]

Inherited from GrpcClient.eventNames
- Defined in node_modules/@types/node/ts4.8/events.d.ts:72
Returns (string | symbol)[]

failJobSync

failJobSync(failJobRequest: FailJobRequest): Promise<void>

- Defined in src/lib/interfaces-1.0.ts:456
Parameters
- failJobRequest: FailJobRequest
Returns Promise<void>

getMaxListeners

getMaxListeners(): number

Inherited from GrpcClient.getMaxListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:64
Returns number

listMethods

listMethods(): string[]

Inherited from GrpcClient.listMethods
- Defined in src/lib/GrpcClient.ts:411
Returns string[]

listenerCount

listenerCount(event: string | symbol): number

Inherited from GrpcClient.listenerCount
- Defined in node_modules/@types/node/ts4.8/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from GrpcClient.listeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

modifyProcessInstanceSync

modifyProcessInstanceSync(request: ModifyProcessInstanceRequest): Promise<ModifyProcessInstanceResponse>

- Defined in src/lib/interfaces-1.0.ts:466
Parameters
- request: ModifyProcessInstanceRequest
Returns Promise<ModifyProcessInstanceResponse>

off

off(event: string | symbol, listener: (...args: any[]) => void): ZBGrpc

Inherited from GrpcClient.off
- Defined in node_modules/@types/node/ts4.8/events.d.ts:61
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ZBGrpc

on

on(event: string | symbol, listener: (...args: any[]) => void): ZBGrpc

Inherited from GrpcClient.on
- Defined in node_modules/@types/node/ts4.8/events.d.ts:58
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ZBGrpc

once

once(event: string | symbol, listener: (...args: any[]) => void): ZBGrpc

Inherited from GrpcClient.once
- Defined in node_modules/@types/node/ts4.8/events.d.ts:59
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ZBGrpc

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ZBGrpc

Inherited from GrpcClient.prependListener
- Defined in node_modules/@types/node/ts4.8/events.d.ts:70
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ZBGrpc

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ZBGrpc

Inherited from GrpcClient.prependOnceListener
- Defined in node_modules/@types/node/ts4.8/events.d.ts:71
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ZBGrpc

publishMessageSync

publishMessageSync(publishMessageRequest: PublishMessageRequest<IInputVariables>): Promise<PublishMessageResponse>

- Defined in src/lib/interfaces-1.0.ts:439
Parameters
- publishMessageRequest: PublishMessageRequest<IInputVariables>
Returns Promise<PublishMessageResponse>

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from GrpcClient.rawListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): ZBGrpc

Inherited from GrpcClient.removeAllListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:62
Parameters
- Optional event: string | symbol
Returns ZBGrpc

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ZBGrpc

Inherited from GrpcClient.removeListener
- Defined in node_modules/@types/node/ts4.8/events.d.ts:60
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ZBGrpc

resolveIncidentSync

resolveIncidentSync(resolveIncidentRequest: ResolveIncidentRequest): Promise<void>

- Defined in src/lib/interfaces-1.0.ts:468
Parameters
- resolveIncidentRequest: ResolveIncidentRequest
Returns Promise<void>

runService

runService(fnName: any, data: any, fnAnswer: any): void

Inherited from GrpcClient.runService
- Defined in src/lib/GrpcClient.ts:407
Parameters
- fnName: any
- data: any
- fnAnswer: any
Returns void

setMaxListeners

setMaxListeners(n: number): ZBGrpc

Inherited from GrpcClient.setMaxListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:63
Parameters
- n: number
Returns ZBGrpc

setVariablesSync

setVariablesSync(request: SetVariablesRequest<IProcessVariables>): Promise<void>

- Defined in src/lib/interfaces-1.0.ts:467
Parameters
- request: SetVariablesRequest<IProcessVariables>
Returns Promise<void>

throwErrorSync

throwErrorSync(throwErrorRequest: ThrowErrorRequest): Promise<void>

- Defined in src/lib/interfaces-1.0.ts:442
Parameters
- throwErrorRequest: ThrowErrorRequest
Returns Promise<void>

topologySync

topologySync(): Promise<TopologyResponse>

- Defined in src/lib/interfaces-1.0.ts:443
Returns Promise<TopologyResponse>

updateJobRetriesSync

updateJobRetriesSync(updateJobRetriesRequest: UpdateJobRetriesRequest): Promise<void>

- Defined in src/lib/interfaces-1.0.ts:444
Parameters
- updateJobRetriesRequest: UpdateJobRetriesRequest
Returns Promise<void>

Generated using TypeDoc