Type Alias SharingTaskRecurringCreateRequest

type SharingTaskRecurringCreateRequest = {
    appName?: string;
    cleanupStrategy?: CleanupStrategy;
    dataConnectionID?: string;
    description?: string;
    distributionListId?: string;
    emailContent?: EmailComposition;
    enabled?: boolean;
    executeOnCreation?: boolean;
    expiration?: string;
    message?: string;
    name: string;
    recipients?: SharingTaskRecurringRecipients;
    retentionPolicy?: RetentionPolicy;
    scheduleOptions?: ScheduleOptions;
    sharePointFolder?: string;
    spaceId?: string;
    startTime?: string;
    state: State;
    subType?: "pdf" | "pptx" | "xlsx" | "html" | "docx";
    tags?: string[];
    templates: TemplateResult[];
    transportChannels?: ("email" | "sharepoint")[];
    trigger?: Trigger;
    type:
        | "chart-monitoring"
        | "chart-sharing"
        | "sheet-sharing"
        | "template-sharing";
}
Index

Properties

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

Properties

appName?: string

Name of the app associated (through the templates) with this sharing task

cleanupStrategy?: CleanupStrategy

A bookmark is considered old if its modification date is older than the app creation date.

dataConnectionID?: string

the id of the data connection

description?: string

Description of the sharing task

distributionListId?: string

the id of the distribution list associated to the app

emailContent?: EmailComposition
enabled?: boolean

Toggle for enabling sharing task.

executeOnCreation?: boolean

making this true will execute the sharing task upon creation regardless of next trigger

expiration?: string

Timestamp for the termination of the task

message?: string

Message along with sharing task

name: string

Name of this sharing task

recipients?: SharingTaskRecurringRecipients

List of recipients. An internal recipient is represented by their user id.

retentionPolicy?: RetentionPolicy
scheduleOptions?: ScheduleOptions
sharePointFolder?: string

the SharePoint folder to upload the report to

spaceId?: string

Space ID of the sharing task

startTime?: string

Time to start capturing the history

state: State

State of the selections and jsOpts

subType?: "pdf" | "pptx" | "xlsx" | "html" | "docx"

the sharing task resource mashup sub type.

tags?: string[]

used to assign sharing task to a collection bucket (tags)

templates: TemplateResult[]
transportChannels?: ("email" | "sharepoint")[]

the transport type for the report

trigger?: Trigger
type:
    | "chart-monitoring"
    | "chart-sharing"
    | "sheet-sharing"
    | "template-sharing"

the sharing task resource type.

Settings

Member Visibility

On This Page

Properties