|
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.ReplyToThread
public class ReplyToThread
Posts a reply message in a forum thread using information in an email message. Instances of this class are initialized with the subject and body text to post, as well as any attachments. A message id is also supplied, and is used to identify the parent of the forum message which will be created.
Constructor Summary | |
---|---|
ReplyToThread(java.lang.String subject,
java.lang.String message,
long messageID,
java.util.Iterator attachments,
AuthToken authToken)
Sole constructor. |
Method Summary | |
---|---|
void |
execute()
Replies to a message using the parameters supplied in the constructor. |
long |
getActingUserID()
Returns the id of the user this instance will act as. |
long |
getTargetObjectID()
Returns the id of the object this action will act on. |
int |
getTargetObjectType()
Returns the type of object this action will act on. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ReplyToThread(java.lang.String subject, java.lang.String message, long messageID, java.util.Iterator attachments, AuthToken authToken)
ForumMessage
and uses it to
reply to the message specified by the supplied messageID as the User
specified by the
supplied AuthToken
.
subject
- the subject of the new message.message
- the body of the new message.messageID
- the id of the thread or message to reply to.attachments
- an Iterator
of AttachmentData
representing file attachments.authToken
- the AuthToken
of the user to reply as.
java.lang.IllegalArgumentException
- if messageID is less than zero.Method Detail |
---|
public void execute() throws EmailMonitorException
execute
in interface EmailAction
EmailMonitorException
- if the specified message or user does not exist or the user doesn't have permission
to post a message.public long getActingUserID()
EmailAction
getActingUserID
in interface EmailAction
public int getTargetObjectType()
EmailAction
JiveConstants
. Note this is not necessarily the type of object
that will be created - it is the type of object which will be modified. For example, if this action
created a new thread, the object type would be JiveConstants.FORUM
,
and EmailAction.getTargetObjectID()
would return the id of the forum in which the thread would be created.
getTargetObjectType
in interface EmailAction
public long getTargetObjectID()
EmailAction
getTargetObjectID
in interface EmailAction
public java.lang.String toString()
toString
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |