Interface UserMessageAttachmentUpload
- 
 public interface UserMessageAttachmentUploadInterface defining the actions that can be made when uploading an attachment to a user message
- 
- 
Field SummaryFields Modifier and Type Field Description static StringATTACHMENT_PREFIX
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcancel()Cancel the upload process and clean up any resourcesvoidcomplete()Complete the upload processWritableJobFilegetJobFile()Get the job file associated with this upload.voidsetFormat(Format format)Set the format for the file
 
- 
- 
- 
Field Detail- 
ATTACHMENT_PREFIXstatic final String ATTACHMENT_PREFIX - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getJobFileWritableJobFile getJobFile() Get the job file associated with this upload.- Returns:
- the job file
 
 - 
completevoid complete() throws com.redwood.scheduler.api.exception.UserMessageAttachmentExceptionComplete the upload process- Throws:
- com.redwood.scheduler.api.exception.UserMessageAttachmentException- if the attachment is vetoed by the triggers or actions
 
 - 
setFormatvoid setFormat(Format format) Set the format for the file- Parameters:
- format- the format of the file
 
 - 
cancelvoid cancel() Cancel the upload process and clean up any resources
 
- 
 
-