@camunda8/sdk
    Preparing search index...

    Interface ZBGrpc

    interface ZBGrpc {
        activateJobsStream: (
            req: ActivateJobsRequest,
        ) => Promise<StreamWithError>;
        channelClosed: boolean;
        client: Client;
        completeJobSync: (req: CompleteJobRequest) => Promise<void>;
        connected: boolean;
        deleteResourceSync: (
            deleteResourceRequest: DeleteResourceRequest,
        ) => Promise<Record<string, never>>;
        host: string;
        longPoll?: MaybeTimeDuration;
        streamActivatedJobsStream: (
            req: StreamActivatedJobsRequest,
        ) => Promise<ClientReadableStream<unknown>>;
        broadcastSignalSync(
            signal: BroadcastSignalRequest,
        ): Promise<BroadcastSignalResponse>;
        cancelProcessInstanceSync(
            processInstanceKey: {
                operationReference?: string;
                processInstanceKey: string | number;
            },
        ): Promise<void>;
        close(timeout?: number): Promise<void>;
        createProcessInstanceSync(
            createProcessInstanceRequest: CreateProcessInstanceRequest,
        ): Promise<CreateProcessInstanceResponse>;
        createProcessInstanceWithResultSync(
            createProcessInstanceWithResultRequest: CreateProcessInstanceWithResultRequest,
        ): Promise<CreateProcessInstanceWithResultResponseOnWire>;
        deployResourceSync<T>(
            resource: DeployResourceRequest,
        ): Promise<DeployResourceResponse<T>>;
        evaluateDecisionSync(
            evaluateDecisionRequest: EvaluateDecisionRequest,
        ): Promise<EvaluateDecisionResponse>;
        failJobSync(failJobRequest: FailJobRequest): Promise<void>;
        listMethods(): string[];
        migrateProcessInstanceSync(
            request: MigrateProcessInstanceRequest,
        ): Promise<MigrateProcessInstanceResponse>;
        modifyProcessInstanceSync(
            request: ModifyProcessInstanceRequest,
        ): Promise<ModifyProcessInstanceResponse>;
        publishMessageSync(
            publishMessageRequest: PublishMessageRequest,
        ): Promise<PublishMessageResponse>;
        resolveIncidentSync(
            resolveIncidentRequest: ResolveIncidentRequest,
        ): Promise<void>;
        runService(fnName: any, data: any, fnAnswer: any): void;
        setVariablesSync(request: SetVariablesRequestOnTheWire): Promise<void>;
        throwErrorSync(throwErrorRequest: ThrowErrorRequest): Promise<void>;
        topologySync(): Promise<TopologyResponse>;
        updateJobRetriesSync(
            updateJobRetriesRequest: UpdateJobRetriesRequest,
        ): Promise<void>;
        updateJobTimeoutSync(
            updateJobTimeoutRequest: UpdateJobTimeoutRequest,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    activateJobsStream channelClosed client completeJobSync connected deleteResourceSync host longPoll? streamActivatedJobsStream

    Methods

    broadcastSignalSync cancelProcessInstanceSync close createProcessInstanceSync createProcessInstanceWithResultSync deployResourceSync evaluateDecisionSync failJobSync listMethods migrateProcessInstanceSync modifyProcessInstanceSync publishMessageSync resolveIncidentSync runService setVariablesSync throwErrorSync topologySync updateJobRetriesSync updateJobTimeoutSync

    Properties

    activateJobsStream: (req: ActivateJobsRequest) => Promise<StreamWithError>
    channelClosed: boolean = false
    client: Client
    completeJobSync: (req: CompleteJobRequest) => Promise<void>
    connected: boolean = false
    deleteResourceSync: (
        deleteResourceRequest: DeleteResourceRequest,
    ) => Promise<Record<string, never>>
    host: string
    longPoll?: MaybeTimeDuration
    streamActivatedJobsStream: (
        req: StreamActivatedJobsRequest,
    ) => Promise<ClientReadableStream<unknown>>

    Methods

    • Parameters

      • processInstanceKey: { operationReference?: string; processInstanceKey: string | number }

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods