Java API for Scheduling Emailing of Worksheets

Applies to: Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Overview

API to schedule emailing of worksheets.

Example

API to schedule emailing of worksheets.

/**
  * Methods to schedule Email once/recur/now
  * @param worksheetName - Name of the worksheet to email.
  * @param workbookName - Name of the workbook containing worksheet.
  * @param folderName - Name of the folder containing workbook.
  * @param emailDetails - Object of class EmailDetails that contains information about user
  * @param onceDateTime - Date time in format MM/DD/YY hh:mm:ss
  * @param applicationURL - Url of the application to be attached in an email.
  * @param requestorUserInfo - Requested user information.
  * @param recipients - It can be USER/GROUP/EXTERNAL USER present in enums EmailDetails.RECIPIENTTYPE
  * @param additionalParam - To pass any additional parameter or else can be passed as null
  */
ReportObjectManager rom = new ReportObjectManager();
EmailDetails emailDetailsObject  = new EmailDetails();
emailDetailsObject.addRecipient(String recipients, String userName,String userID);
emailDetailsObject.addRecipient(String recipients, String externalEmail, null);
public ResponseStatus EmailSheetOnce(String worksheetName, String workbookName,String  folderName, String onceDateTime, EmailDetails emailDetailsObject ,String additionalParam,String applicationURL , UserInfo userInfo);

public ResponseStatus EmailSheetNow(String worksheetName, String workbookName,String folderName,EmailDetails emailDetailsObject,String additionalParam,String applicationURL,UserInfo userInfo);
ScheduleJob schJob = new ScheduleJob();
Schedule sch = new Schedule();
sch.setStartDate(MM/DD/YYYY);
sch.setOnceTime(hh:mm);
schJob.setScheduleObj(sch);
public ResponseStatus EmailSheetRecur(String worksheetName,String workbookName,String folderName, schJob,EmailDetails emailDetailsObject,String additionalParam,String applicationURL ,UserInfo userInfo);