Interface ISharingTaskRecurringCreateRequest

interface ISharingTaskRecurringCreateRequest {
    appName: string;
    dataConnectionID?: string;
    description?: string;
    distributionListId: string;
    emailContent?: {
        body: string;
        subject: string;
    };
    enabled?: boolean;
    executeOnCreation?: boolean;
    expiration?: string;
    message?: string;
    name: string;
    recipients?: ISharingTaskRecurringRecipients;
    retentionPolicy?: {
        historySize: number;
        overrideInterval: string;
    };
    scheduleOptions?: {
        chronosJobID: string;
        endDateTime: string;
        lastExecutionTime: string;
        nextExecutionTime: string;
        recurrence: string[];
        startDateTime: string;
        timezone: string;
    };
    sharePointFolder?: string;
    startTime?: string;
    state: {
        fields: {}[];
        queryItems: {}[];
        selections: {
            displayName?: string;
            displayValues?: string[];
            isNumeric: boolean;
            name: string;
            stateName: string;
            values: string[];
        }[];
    };
    subType?: string;
    tags?: string[];
    templates: ITemplateResult[];
    transportChannels?: string[];
    trigger?: {
        chronosJobID?: string;
        executeOnAppReload?: boolean;
        executionHistoryInterval?: string;
        recurrence: string[];
    };
    type: "chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing";
}

Properties

appName dataConnectionID? description? distributionListId emailContent? enabled? executeOnCreation? expiration? message? name recipients? retentionPolicy? scheduleOptions? sharePointFolder? startTime? state subType? tags? templates transportChannels? trigger? type

Properties

appName

appName: string

Deprecated

https://qlik.dev/changelog/77-api-deprecation-sharing-tasks/

Optional dataConnectionID

dataConnectionID?: string

Optional description

description?: string

distributionListId

distributionListId: string

Optional emailContent

emailContent?: {
    body: string;
    subject: string;
}

Type declaration

  • body: string
  • subject: string

Optional enabled

enabled?: boolean

Optional executeOnCreation

executeOnCreation?: boolean

Optional expiration

expiration?: string

Optional message

message?: string

name

name: string

Optional recipients

recipients?: ISharingTaskRecurringRecipients

Optional retentionPolicy

retentionPolicy?: {
    historySize: number;
    overrideInterval: string;
}

Type declaration

  • historySize: number
  • overrideInterval: string

Optional scheduleOptions

scheduleOptions?: {
    chronosJobID: string;
    endDateTime: string;
    lastExecutionTime: string;
    nextExecutionTime: string;
    recurrence: string[];
    startDateTime: string;
    timezone: string;
}

Type declaration

  • chronosJobID: string
  • endDateTime: string
  • lastExecutionTime: string
  • nextExecutionTime: string
  • recurrence: string[]
  • startDateTime: string
  • timezone: string

Optional sharePointFolder

sharePointFolder?: string

Optional startTime

startTime?: string

state

state: {
    fields: {}[];
    queryItems: {}[];
    selections: {
        displayName?: string;
        displayValues?: string[];
        isNumeric: boolean;
        name: string;
        stateName: string;
        values: string[];
    }[];
}

Type declaration

  • fields: {}[]
  • queryItems: {}[]
  • selections: {
        displayName?: string;
        displayValues?: string[];
        isNumeric: boolean;
        name: string;
        stateName: string;
        values: string[];
    }[]

Optional subType

subType?: string

Optional tags

tags?: string[]

templates

templates: ITemplateResult[]

Optional transportChannels

transportChannels?: string[]

Optional trigger

trigger?: {
    chronosJobID?: string;
    executeOnAppReload?: boolean;
    executionHistoryInterval?: string;
    recurrence: string[];
}

Type declaration

  • Optional chronosJobID?: string
  • Optional executeOnAppReload?: boolean
  • Optional executionHistoryInterval?: string
  • recurrence: string[]

type

type: "chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing"

Settings

Member Visibility

Theme

On This Page