com.smartsheet.api.models

Class AutomationAction

java.lang.Object

com.smartsheet.api.models.AutomationAction

public class AutomationAction
extends Object

Constructor Summary

Constructors

Constructor and Description
AutomationAction()

Method Summary

Modifier and Type	Method and Description
AutomationActionFrequency	getFrequency() Gets the automation action frequency
Boolean	getIncludeAllColumns() Gets the flag indicating if all columns in the sheet should be included with the email
Boolean	getIncludeAttachments() Gets the flag indicating if attachments should be included with the email
List<Long>	getIncludedColumnIds() Gets the list of included columns
Boolean	getIncludeDiscussions() Gets the flag indicating if discussions should be included with the email
String	getMessage() Gets the email body
Boolean	getNotifyAllSharedUsers() Gets the flag indicating if notification should be sent to all shared users
List<Long>	getRecipientColumnIds() Gets a list of columns from which to collect email recipients
List<Recipient>	getRecipients() Gets the list of Recipients
String	getSubject() Gets the email subject line
AutomationActionType	getType() Gets the automation action type
AutomationAction	setFrequency(AutomationActionFrequency frequency) Sets the automation action frequency
AutomationAction	setIncludeAllColumns(Boolean includeAllColumns) Sets the flag indicating if all columns in the sheet should be included with the email
AutomationAction	setIncludeAttachments(Boolean includeAttachments) Sets the flag indicating if attachments should be included with the email
AutomationAction	setIncludedColumnIds(List<Long> includedColumnIds) Sets the list of included columns
AutomationAction	setIncludeDiscussions(Boolean includeDiscussions) Sets the flag indicating if discussions should be included with the email
AutomationAction	setMessage(String message) Sets the email body
AutomationAction	setNotifyAllSharedUsers(Boolean notifyAllSharedUsers) Sets the flag indicating if notification should be sent to all shared users
AutomationAction	setRecipientColumnIds(List<Long> recipientColumnIds) Sets a list of columns from which to collect email recipients
AutomationAction	setRecipients(List<Recipient> recipients) Sets the list of Recipients
AutomationAction	setSubject(String subject) Sets the email subject line
AutomationAction	setType(AutomationActionType type) Sets the automation action type

Methods inherited from class java.lang.Object

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

Constructor Detail

AutomationAction

public AutomationAction()

Method Detail

getFrequency

public AutomationActionFrequency getFrequency()

Gets the automation action frequency

Returns:

the automation action frequency

setFrequency

public AutomationAction setFrequency(AutomationActionFrequency frequency)

Sets the automation action frequency

Parameters:

frequency - the automation action frequency

getIncludeAllColumns

public Boolean getIncludeAllColumns()

Gets the flag indicating if all columns in the sheet should be included with the email

Returns:

includeAllColumns flag

setIncludeAllColumns

public AutomationAction setIncludeAllColumns(Boolean includeAllColumns)

Sets the flag indicating if all columns in the sheet should be included with the email

Parameters:

includeAllColumns - includeAllColumns flag

getIncludeAttachments

public Boolean getIncludeAttachments()

Gets the flag indicating if attachments should be included with the email

Returns:

the includeAttachments flag

setIncludeAttachments

public AutomationAction setIncludeAttachments(Boolean includeAttachments)

Sets the flag indicating if attachments should be included with the email

Parameters:

includeAttachments - the includeAttachments flag

getIncludeDiscussions

public Boolean getIncludeDiscussions()

Gets the flag indicating if discussions should be included with the email

Returns:

the includeDiscussions flag

setIncludeDiscussions

public AutomationAction setIncludeDiscussions(Boolean includeDiscussions)

Sets the flag indicating if discussions should be included with the email

Parameters:

includeDiscussions - the includeDiscussions flag

getIncludedColumnIds

public List<Long> getIncludedColumnIds()

Gets the list of included columns

Returns:

the list of included columns

setIncludedColumnIds

public AutomationAction setIncludedColumnIds(List<Long> includedColumnIds)

Sets the list of included columns

Parameters:

includedColumnIds - the list of included columns

getMessage

public String getMessage()

Gets the email body

Returns:

the email body

setMessage

public AutomationAction setMessage(String message)

Sets the email body

Parameters:

message - the email body

getNotifyAllSharedUsers

public Boolean getNotifyAllSharedUsers()

Gets the flag indicating if notification should be sent to all shared users

Returns:

the notifyAllSharedUsers flag

setNotifyAllSharedUsers

public AutomationAction setNotifyAllSharedUsers(Boolean notifyAllSharedUsers)

Sets the flag indicating if notification should be sent to all shared users

Parameters:

notifyAllSharedUsers - the notifyAllSharedUsers flag

getRecipientColumnIds

public List<Long> getRecipientColumnIds()

Gets a list of columns from which to collect email recipients

Returns:

the list of column IDs

setRecipientColumnIds

public AutomationAction setRecipientColumnIds(List<Long> recipientColumnIds)

Sets a list of columns from which to collect email recipients

Parameters:

recipientColumnIds - the list of column IDs

getRecipients

public List<Recipient> getRecipients()

Gets the list of Recipients

Returns:

the list of Recipients

setRecipients

public AutomationAction setRecipients(List<Recipient> recipients)

Sets the list of Recipients

Parameters:

recipients - the list of Recipients

getSubject

public String getSubject()

Gets the email subject line

Returns:

the email subject line

setSubject

public AutomationAction setSubject(String subject)

Sets the email subject line

Parameters:

subject - the email subject line

getType

public AutomationActionType getType()

Gets the automation action type

Returns:

the action type

setType

public AutomationAction setType(AutomationActionType type)

Sets the automation action type

Parameters:

type - the action type