webadmin::StarReports Interface Reference

Public Member Functions
void	get (out StarReportList list, out ReportConfig allUsers)
void	set (out kerio::web::ErrorList errors, in StarReportList reports, in ReportConfig allUsers)
void	send (out kerio::web::ErrorList errors, in StarReportList reports, in string language)

Member Function Documentation

void webadmin::StarReports::get	(	out StarReportList	list,
		out ReportConfig	allUsers
	)

Returns list of StaR reports entries

Parameters

list	- list of entries
allUsers	- Structure telling whether to send individual reports to each person reularly and wheter to allow them to see their reposrt online.

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::StarReports::send	(	out kerio::web::ErrorList	errors,
		in StarReportList	reports,
		in string	language
	)

Immediately enqueues StaR report for send

Parameters

errors	- list of errors 1002 No such entity. - "Unable to send weekly report, data for previous week are missing." 1002 No such entity. - "Unable to send monthly report, data for previous month are missing."
reports	- list of addressees and types of the report
language	- language of the report

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::StarReports::set	(	out kerio::web::ErrorList	errors,
		in StarReportList	reports,
		in ReportConfig	allUsers
	)

Stores StaR reports entries

Parameters

errors	- list of errors 8002 Database error. - "Unable to modify StaR report entry for '%1'." 8002 Database error. - "Unable to create StaR report entry for '%1'." 8002 Database error. - "Unable to remove StaR report entry for '%1'."
reports	- list of report configurations to be send regularly.
allUsers	- Structure telling whether to send individual reports to each person reularly and wheter to allow them to see their reposrt online.

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

---

The documentation for this interface was generated from the following file:

• StarReports.idl