com.smartsheet.api.models

Class SheetEmail.AddSheetEmailBuilder

java.lang.Object

com.smartsheet.api.models.SheetEmail.AddSheetEmailBuilder

Enclosing class:

SheetEmail

public static class SheetEmail.AddSheetEmailBuilder
extends Object

A convenience class to help create a SheetEmail object with the appropriate fields.

Constructor Summary

Constructors

Constructor and Description
AddSheetEmailBuilder()

Method Summary

Modifier and Type	Method and Description
SheetEmail	build() Builds the sheetEmail.
Boolean	getCcMe() Gets the carbon copy me flag.
SheetEmailFormat	getFormat() Gets the sheet email format (PDF or Excel).
FormatDetails	getFormatDetails() Gets the format details (paper dimensions).
String	getMessage() Gets the message.
List<Recipient>	getSendTo() Gets the list of recipients to send to
String	getSubject() Gets the subject.
SheetEmail.AddSheetEmailBuilder	setCcMe(Boolean ccMe) Sets the carbon copy me flag.
SheetEmail.AddSheetEmailBuilder	setFormat(SheetEmailFormat format) Sets the sheet email format (PDF or Excel).
SheetEmail.AddSheetEmailBuilder	setFormatDetails(FormatDetails formatDetails) Sets the format details (paper dimensions).
SheetEmail.AddSheetEmailBuilder	setMessage(String message) Sets the message.
SheetEmail.AddSheetEmailBuilder	setSendTo(List<Recipient> sendTo) Sets the list of recipients to send to
SheetEmail.AddSheetEmailBuilder	setSubject(String subject) Sets the subject.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddSheetEmailBuilder

public AddSheetEmailBuilder()

Method Detail

getFormat

public SheetEmailFormat getFormat()

Gets the sheet email format (PDF or Excel).

Returns:

the format

setFormat

public SheetEmail.AddSheetEmailBuilder setFormat(SheetEmailFormat format)

Sets the sheet email format (PDF or Excel).

Parameters:

format - the new format

Returns:

the builder

getFormatDetails

public FormatDetails getFormatDetails()

Gets the format details (paper dimensions).

Returns:

the format details

setFormatDetails

public SheetEmail.AddSheetEmailBuilder setFormatDetails(FormatDetails formatDetails)

Sets the format details (paper dimensions).

Parameters:

formatDetails - the new format details

Returns:

the builder

getSendTo

public List<Recipient> getSendTo()

Gets the list of recipients to send to

Returns:

the list of recipients

setSendTo

public SheetEmail.AddSheetEmailBuilder setSendTo(List<Recipient> sendTo)

Sets the list of recipients to send to

Parameters:

sendTo - list of recipients

Returns:

the associated builder

getSubject

public String getSubject()

Gets the subject.

Returns:

the subject

setSubject

public SheetEmail.AddSheetEmailBuilder setSubject(String subject)

Sets the subject.

Parameters:

subject - the new subject

Returns:

the associated builder

getMessage

public String getMessage()

Gets the message.

Returns:

the message

setMessage

public SheetEmail.AddSheetEmailBuilder setMessage(String message)

Sets the message.

Parameters:

message - the new message

Returns:

the associated builder

getCcMe

public Boolean getCcMe()

Gets the carbon copy me flag.

Returns:

the cc me

setCcMe

public SheetEmail.AddSheetEmailBuilder setCcMe(Boolean ccMe)

Sets the carbon copy me flag.

Parameters:

ccMe - the new cc me

Returns:

the associated builder

build

public SheetEmail build()

Builds the sheetEmail.

Returns:

the sheetEmail