GetClientJobs Method

Summary

Retrieves all jobs from the Job Processor for the specified client (user).

Syntax
C#
VB
C++
[OperationContractAttribute()] 
[FaultContractAttribute(System.Type)] 
public GetClientJobsResponse GetClientJobs( 
   GetClientJobsRequest request 
) 
<OperationContractAttribute(), 
   FaultContractAttribute(System.Type)> 
 Public Function GetClientJobs( 
   ByVal request As GetClientJobsRequest 
) As GetClientJobsResponse 
public:  
   [OperationContractAttribute] 
   [FaultContractAttribute(System::Type)] 
   GetClientJobsResponse^ GetClientJobs( 
      GetClientJobsRequest^ request 
   )

Parameters

request
A Leadtools.Services.JobProcessor.DataContracts.GetClientJobsRequest class containing the client (user) information.

Return Value

A Leadtools.Services.JobProcessor.DataContracts.GetClientJobsResponse class containing all jobs for the specified user.

Remarks

Use this method to retrieve all jobs for a given user. This method will return all jobs with a matching value in the cUserToken column. The Leadtools.Services.JobProcessor.DataContracts.GetClientJobsResponse class will contain an array of all job IDs matching the specified user token. If no matching jobs are found, a zero length array is returned.

Example
C#
VB
using LeadtoolsJobProcessorExamples.JobService; 
 
public void GetClientJobs() 
{ 
   using (JobServiceClient jobServiceClient = new JobServiceClient()) 
   { 
      //Get all the jobs with a user token of "user1". 
      GetClientJobsRequest getClientJobsRequest = new GetClientJobsRequest(); 
      getClientJobsRequest.UserToken = "User2"; 
      GetClientJobsResponse getClientJobsResponse = jobServiceClient.GetClientJobs(getClientJobsRequest); 
      foreach (string jobID in getClientJobsResponse.JobsIds) 
         Console.WriteLine(String.Format("ID = {0}", jobID)); 
   } 
} 
Public Sub GetClientJobs() 
   Using jobServiceClient As JobServiceClient = New JobServiceClient() 
      'Get all the jobs with a user token of "user1". 
      Dim getClientJobsRequest As GetClientJobsRequest = New GetClientJobsRequest() 
      getClientJobsRequest.UserToken = "User2" 
      Dim getClientJobsResponse As GetClientJobsResponse = jobServiceClient.GetClientJobs(getClientJobsRequest) 
      For Each jobID As String In getClientJobsResponse.JobsIds 
         Console.WriteLine(String.Format("ID = {0}", jobID)) 
      Next jobID 
   End Using 
End Sub

Requirements

Target Platforms

Help Version 20.0.2020.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.