|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.mail.EmailActionBuilder
public class EmailActionBuilder
A builder object for EmailAction
instances. Different types may be returned based on the
properties set before calling buildAction(). For instance, if JiveConstants.MESSAGE
is supplied as the object type, the object id property
will be used as a message id, and the resulting action will reply to that message.
Constructor Summary | |
---|---|
EmailActionBuilder()
|
Method Summary | |
---|---|
EmailAction |
buildAction()
Creates and returns an instance of EmailAction using the properties which have been set before calling
this method. |
void |
clear()
Resets all property values to their defaults, so an instance can be reused to create different actions. |
void |
setAuthToken(AuthToken authToken)
Sets the AuthToken of the user to act as. |
void |
setMessageAttachments(java.util.Iterator attachments)
Sets the Iterator of attachments found in the incoming message. |
void |
setMessageBody(java.lang.String body)
Sets the body of the incoming message. |
void |
setMessageSubject(java.lang.String subject)
Sets the subject of the incoming message. |
void |
setObjectID(long objectID)
Sets an object id, which is used differently depending on the object type property. |
void |
setObjectType(int objectType)
Sets the object type to act on. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EmailActionBuilder()
Method Detail |
---|
public void setAuthToken(AuthToken authToken)
AuthToken
of the user to act as.
authToken
- the AuthToken
of the user to act as.public void setObjectType(int objectType)
objectType
- one of the constants defined in JiveConstants
which identify a forum element, such as a
message or thread.public void setObjectID(long objectID)
objectID
- an object id.public void setMessageSubject(java.lang.String subject)
subject
- the subject of the incoming message.public void setMessageBody(java.lang.String body)
body
- the body of the incoming message.public void setMessageAttachments(java.util.Iterator attachments)
Iterator
of attachments found in the incoming message. Used when creating replies and threads.
attachments
- the attachments of the incoming message.public EmailAction buildAction()
EmailAction
using the properties which have been set before calling
this method. Throws EmailMonitorException if no action can be determined.
EmailAction
using the properties which have been set before calling
this method, or null if no appropriate action can be determined.public void clear()
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |