dt-common-device/dist/copilotQueue/interfaces/ICopilotQueueService.d.ts

A secure and robust device management library for IoT applications

import { ICopilotQueueRequest, ICopilotQueueOptions } from "./ICopilotQueueRequest";
export interface ICopilotQueueService {
    /**
     * Add a request to the queue for processing
     * @param request - The request data including URL, method, headers, and body (with propertyId)
     * @param options - Optional queue configuration
     * @returns Promise with job ID and queue response
     */
    addQueueRequest(request: ICopilotQueueRequest, options?: ICopilotQueueOptions): Promise<{
        jobId: string;
        queued: boolean;
    }>;
    /**
     * Get the status of a queued job
     * @param jobId - The job ID to check
     * @returns Promise with job status
     */
    getJobStatus(jobId: string): Promise<any>;
    /**
     * Shutdown the queue service
     * @returns Promise that resolves when shutdown is complete
     */
    shutdown(): Promise<void>;
}