ArcGIS Pro 3.6 API Reference Guide
ArcGIS.Desktop.Workflow.Client.Events Namespace / JobMessageEvent Class
Members Example

In This Topic
    JobMessageEvent Class
    In This Topic
    The job message event. Provides event information for job and step events.
    Object Model
    JobMessageEvent ClassSubscriptionToken ClassSubscriptionToken Class
    Syntax
    Example
    Subscribe to job notification messages
    // Subscribe to the job message event to start receiving job and step notifications.
    // Use the subscription token to unsubscribe from the event.
    var subscriptionToken = JobMessageEvent.Subscribe(e =>
    {
      var jobId = e.Message.JobId;
      var msgType = e.MessageType;
      var message = e.Message;
      // Include logic to process the job / step messages
    });
    
    // Subscribe to certain jobs. This will add these jobIds to the list of already subscribed jobs.
    var notifManager = WorkflowClientModule.NotificationManager;
    notifManager.SubscribeToJobs(jobIds);
    Unsubscribe to messages for the given jobs
    // Unsubscribe from the job message event using the subscription token
    JobMessageEvent.Unsubscribe(subscriptionToken);
    
    // Unsubscribe from jobs using the same instance of Notification Manager used to subscribe to jobs.
    // This will remove the jobs from the subscribed job list if no other clients are subscribed to those jobs.
    var notifManager = WorkflowClientModule.NotificationManager;
    notifManager.UnsubscribeFromJobs(jobIds);
    Inheritance Hierarchy

    System.Object
       ArcGIS.Core.Events.EventBase
          ArcGIS.Core.Events.CompositePresentationEvent<TPayload>
             ArcGIS.Desktop.Workflow.Client.Events.JobMessageEvent

    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3.6 or higher.
    See Also