Interface UserMessageAttachmentUpload
-
public interface UserMessageAttachmentUpload
Interface defining the actions that can be made when uploading an attachment to a user message
-
-
Field Summary
Fields Modifier and Type Field Description static String
ATTACHMENT_PREFIX
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
cancel()
Cancel the upload process and clean up any resourcesvoid
complete()
Complete the upload processWritableJobFile
getJobFile()
Get the job file associated with this upload.void
setFormat(com.redwood.scheduler.api.model.Format format)
Set the format for the file
-
-
-
Field Detail
-
ATTACHMENT_PREFIX
static final String ATTACHMENT_PREFIX
- See Also:
- Constant Field Values
-
-
Method Detail
-
getJobFile
WritableJobFile getJobFile()
Get the job file associated with this upload.- Returns:
- the job file
-
complete
void complete() throws com.redwood.scheduler.api.exception.UserMessageAttachmentException
Complete the upload process- Throws:
com.redwood.scheduler.api.exception.UserMessageAttachmentException
- if the attachment is vetoed by the triggers or actions
-
setFormat
void setFormat(com.redwood.scheduler.api.model.Format format)
Set the format for the file- Parameters:
format
- the format of the file
-
cancel
void cancel()
Cancel the upload process and clean up any resources
-
-