ForumThread Type

A ForumThread is a container for a hierarchy of ForumMessages.

Type Template

<...>
    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <communityID>xs:long</communityID>
    <creationDate>xs:dateTime</creationDate>
    <latestMessageID>xs:long</latestMessageID>
    <messageCount>xs:int</messageCount>
    <moderationValue>xs:int</moderationValue>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <rootMessage>
        <!-- Contents of ForumMessage -->
    <rootMessage>
<...>

Note: Element descriptions are split into information that's relevant when you're creating an instance of this type and information relevant when you're receiving an instance of it. Occasionally these will differ.

Elements

Element Description
communityID
Setting
Called by the ForumThreadService to set the ID of the thread this community belongs too.

ForumThreadService will ignore this value if upon update it has changed.

Getting
Returns the ID of the community this thread belongs to.
creationDate
Setting
Sets the creation date of this thread.

ForumThreadService will ignore this value if upon update it has changed.

Getting
Returns the date that this thread was created.
ID
Setting
Set the unique id of this object.
Getting
latestMessageID
Setting
Called by the ForumThreadService to set the appropriate latestMessageID into the thread.

ForumThreadService will ignore this value if upon update it has changed.

Getting
Returns the ID of the most recently created messages in this thread.
messageCount
Setting
Set the number of messages in this thread. This method should only be used by the ForumThreadService itself

ForumThreadService will ignore this value if upon update it has changed.

Getting
Returns the number of messages in the thread. This includes the root message. So, to find the number of replies to the root message, subtract one from the answer of this method.
moderationValue
Setting
Used to change the moderation value of the community.
Getting
Returns the number of moderation points this thread has.

If the moderation value is less than 1 (MESSAGE_MODERATION_VISIBLE) then the thread will not be displayed by default. Because a thread and its root message are intrinsically bound together, their moderation values are linked and are always the same. This means that setting the moderation value on the thread or setting the moderation value of a root message will always affect both objects.

modificationDate
Setting
Sets the date this thread was last modified. This is called by ForumThreadService.

ForumThreadService will ignore this value if upon update it has changed.

Getting
Returns the date that this thread was last modified. In other words, the date of the most recent message in the thread.
name
Setting
Used by ForumThreadService to set the value of this field.

ForumThreadService will ignore this value if upon update it has changed.

Getting
Returns the subject of the root message of this thread. This is a convenience method equivalent to getRootMessage().getSubject().
objectType
Setting
Sets the object type of the jive object.
Getting
rootMessage
Setting
Called by the ForumThreadService to set the appropriate rootMessageID into the thread.

ForumThreadService will ignore this value if upon update it has changed.

Getting
Returns the root message this thread. The root message is a special first message that is intimately tied to the thread for most communityViews. All other messages in the thread are children of the root message.