NotificationManager

1
2
3
4
5
const customEventListener = () => {
 alert('Lost connection with the Workflow Manager server');
}

notificationManager.onDisconnect(customEventListener);

1
2
3
4
5
const customEventListener = () => {
 alert('Established connection with the Workflow Manager server');
}

notificationManager.onReconnect(customEventListener);

1
2
3
4
5
6
7
8
9
10
11
// Respond to server after receiving a Step Info Required message for a Question step.
// Construct a server response message
const stepResponse = {
 jobId: 'job1',
 stepId: 'step4',
 questionResponse: 3, // Response value for the question step
 comment: 'User selected option 3 from a dropdown'
};

// Send the response to server
notificationManager.send(stepResponse);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// Construct a callback handler to receive job messages
async handleJobNotificationMessage(message: NotificationMessage): Promise<void> {
 switch (message.msgType) {
   case 'StepStarted':
     // Message received when a step in a job has started running
     this.handleStepStarted(message); // Implement handler for step started messages
     break;
   case 'StepFinished':
     // Message received when a step in a job is completed
     this.handleStepFinished(message); // Implement handler for step finished messages
     break;
   case 'StepError':
     // Message received when an error occurs while a step in a job was running
     this.handleStepError(message); // Implement handler for step error messages
     break;
   default:
     // Handle other messages
     this.handleOtherMessages(message); // Implement handler for other message types
     break;
 }
}

// Register to receive job notifications for a job
async subscribeToNotifications(jobId: string) {
 // Get a handle to the NotificationManager
 const notificationManager = await ManagerFactory.getManager(NotificationManager, options);

 // Subscribe to job notifications for a particular job. A callbackId is returned to later unsubscribe from the job.
 const callbackId = notificationManager.subscribeToJob(jobId, this.handleJobNotificationMessage);
}

1
2
// Unsubscribe from the job using the callbackId
notificationManager.unsubscribe(callbackId);

1
2
// Unsubscribe from all job notifications
notificationManager.unsubscribeFromAll();