qlik-saas-api/dist/modules/SharingTasks.d.ts

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
import { ISharingTaskRecurringRecipients, ITemplateResult, SharingTask } from "./SharingTask";
import { SharingTasksSettings } from "./SharingTasksSettings";
export interface ISharingTaskRecurringCreateRequest {
    name: string;
    type: "chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing";
    state: {
        fields: {}[];
        queryItems: {}[];
        selections: {
            name: string;
            values: string[];
            isNumeric: boolean;
            stateName: string;
            displayName?: string;
            displayValues?: string[];
        }[];
    };
    /**
     * @deprecated https://qlik.dev/changelog/77-api-deprecation-sharing-tasks/
     */
    appName: string;
    enabled?: boolean;
    message?: string;
    subType?: string;
    tags?: string[];
    trigger?: {
        recurrence: string[];
        chronosJobID?: string;
        executeOnAppReload?: boolean;
        executionHistoryInterval?: string;
    };
    startTime?: string;
    templates: ITemplateResult[];
    expiration?: string;
    recipients?: ISharingTaskRecurringRecipients;
    description?: string;
    emailContent?: {
        body: string;
        subject: string;
    };
    retentionPolicy?: {
        historySize: number;
        overrideInterval: string;
    };
    scheduleOptions?: {
        timezone: string;
        recurrence: string[];
        endDateTime: string;
        chronosJobID: string;
        startDateTime: string;
        lastExecutionTime: string;
        nextExecutionTime: string;
    };
    dataConnectionID?: string;
    sharePointFolder?: string;
    executeOnCreation?: boolean;
    transportChannels?: string[];
    distributionListId: string;
}
export declare class SharingTasks {
    #private;
    settings: SharingTasksSettings;
    constructor(saasClient: QlikSaaSClient);
    get(arg: {
        id: string;
    }): Promise<SharingTask>;
    /**
     * Returns a list of sharing tasks as an instance
     */
    getAll(): Promise<any>;
    /**
     * Creates a new recurring sharing task
     */
    create(arg: ISharingTaskRecurringCreateRequest): Promise<SharingTask>;
}