Package com.gooddata.sdk.model.md
Class ScheduledMail
java.lang.Object
com.gooddata.sdk.model.md.AbstractObj
com.gooddata.sdk.model.md.ScheduledMail
public class ScheduledMail extends AbstractObj implements Queryable, Updatable
A scheduled mail MD object. It represents a schedule on mail-sending of
exported dashboards and reports.
- See Also:
- Serialized Form
-
Field Summary
Fields inherited from interface com.gooddata.sdk.model.md.Obj
CREATE_URI, CREATE_WITH_ID_URI, OBJ_URI, URI -
Constructor Summary
Constructors Constructor Description ScheduledMail(java.lang.String title, java.lang.String summary)Creates an almost empty instance of the object.ScheduledMail(java.lang.String title, java.lang.String summary, java.lang.String recurrency, java.time.LocalDate startDate, java.lang.String timeZone, java.util.Collection<java.lang.String> toAddresses, java.util.Collection<java.lang.String> bccAddresses, java.lang.String subject, java.lang.String body, java.util.List<Attachment> attachments)Creates full, safe mail schedule object. -
Method Summary
Modifier and Type Method Description ScheduledMailaddBccAddress(java.lang.String bccAdd)ScheduledMailaddDashboardAttachment(java.lang.String uri, java.lang.Integer allTabs, java.lang.String executionContext, java.lang.String... tabs)ScheduledMailaddReportAttachment(ReportDefinition reportDefinition, java.util.Map<java.lang.String,java.lang.String> exportOptions, ExportFormat... formats)ScheduledMailaddReportAttachment(ReportDefinition reportDefinition, java.util.Map<java.lang.String,java.lang.String> exportOptions, java.lang.String... formats)ScheduledMailaddToAddress(java.lang.String toAdd)java.util.Collection<? extends Attachment>getAttachments()java.util.Collection<java.lang.String>getBccAddresses()java.lang.StringgetBody()java.lang.StringgetSubject()java.util.Collection<java.lang.String>getToAddresses()ScheduledMailWhengetWhen()ScheduledMailsetAttachments(java.util.List<Attachment> attachments)ScheduledMailsetBcc(java.util.Collection<java.lang.String> bccAddresses)ScheduledMailsetBody(java.lang.String body)ScheduledMailsetRecurrency(java.lang.String recurrency)ScheduledMailsetStartDate(java.time.LocalDate startDate)ScheduledMailsetSubject(java.lang.String subject)ScheduledMailsetTimeZone(java.lang.String timeZone)ScheduledMailsetTo(java.util.Collection<java.lang.String> toAddresses)java.lang.StringtoString()Methods inherited from class com.gooddata.sdk.model.md.AbstractObj
getAuthor, getCategory, getContributor, getCreated, getFlags, getId, getIdentifier, getSummary, getTags, getTitle, getUpdated, getUri, isDeprecated, isLocked, isProduction, isSharedWithSomeone, isUnlisted, setCategory, setDeprecated, setFlags, setIdentifier, setLocked, setProduction, setSharedWithSomeone, setSummary, setTags, setTitle, setUnlisted, uris
-
Constructor Details
-
ScheduledMail
public ScheduledMail(java.lang.String title, java.lang.String summary)Creates an almost empty instance of the object. It's up to the user's responsibility to call all the necessary setters.- Parameters:
title- the title of the MD objectsummary- the summary of the MD object
-
ScheduledMail
public ScheduledMail(java.lang.String title, java.lang.String summary, java.lang.String recurrency, java.time.LocalDate startDate, java.lang.String timeZone, java.util.Collection<java.lang.String> toAddresses, java.util.Collection<java.lang.String> bccAddresses, java.lang.String subject, java.lang.String body, java.util.List<Attachment> attachments)Creates full, safe mail schedule object.- Parameters:
title- the title of the MD objectsummary- the summary of the MD objectrecurrency- schedule in format defined in schedulestartDate- schedule starting datetimeZone- time zone of the starting datetoAddresses- collection of email addresses to send the mail tobccAddresses- collection of blind copy addresses to send the mail tosubject- the subject of the scheduled mailbody- the text body of the scheduled mailattachments- reports and dashboards to send in the scheduled email
-
-
Method Details
-
getWhen
-
getToAddresses
public java.util.Collection<java.lang.String> getToAddresses() -
getBccAddresses
public java.util.Collection<java.lang.String> getBccAddresses() -
getSubject
public java.lang.String getSubject() -
getBody
public java.lang.String getBody() -
getAttachments
-
setRecurrency
-
setStartDate
-
setTimeZone
-
setTo
-
setBcc
-
setSubject
-
setBody
-
setAttachments
-
addToAddress
-
addBccAddress
-
addReportAttachment
public ScheduledMail addReportAttachment(ReportDefinition reportDefinition, java.util.Map<java.lang.String,java.lang.String> exportOptions, java.lang.String... formats) -
addReportAttachment
public ScheduledMail addReportAttachment(ReportDefinition reportDefinition, java.util.Map<java.lang.String,java.lang.String> exportOptions, ExportFormat... formats) -
addDashboardAttachment
public ScheduledMail addDashboardAttachment(java.lang.String uri, java.lang.Integer allTabs, java.lang.String executionContext, java.lang.String... tabs) -
toString
public java.lang.String toString()- Overrides:
toStringin classAbstractObj
-