IAdmReportScheduledTaskSelfService

The IAdmReportScheduledTaskSelfService interface is used to manage reports scheduled for the currently logged on user.

Inheritance: IAdmTop

To use the IAdmReportScheduledTaskSelfService interface, you need to bind to a Report scheduled task.

Methods

Details

IsReportScheduledForCurrentUser()

Returns a value indicating whether the given report is scheduled for the currently logged on user.

bool IsReportScheduledForCurrentUser(IAdmReport report)

Parameters


GetReportsScheduledForCurrentUser()

Returns an array of reports scheduled for the currently logged on user.

IAdmScheduledReportData[] GetReportsScheduledForCurrentUser()

Remarks

The method does not resolve value references.


ScheduleForCurrentUser()

Schedules report generation and delivery for the currently logged on user.

void ScheduleForCurrentUser(IAdmScheduledReportData scheduleData)

Parameters

scheduleData - Specifies parameters for report generation and delivery.


UnscheduleForCurrentUser()

Removes a report from the list of reports scheduled for the currently logged on user.

int UnscheduleForCurrentUser(IAdmScheduledReportData scheduleData)

Parameters

The scheduleData parameter represents the report to unschedule. Set the parameter to null, to remove all reports scheduled for the currently logged on user.

Return value

The method returns the number of unscheduled reports.


Requirements

Minimum required version: 2018.1

See also