Package com.appiancorp.suiteapi.forums
Class ThreadedMessage
java.lang.Object
com.appiancorp.suiteapi.forums.ThreadedMessage
Deprecated.
The Discussion Forums functionality will be removed in a future release. Use the News feed
and related smart services to build applications with similar functionality.
A convenience class that gathers the information required by clients to
display a list of threads and their contained messages.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IntegerDeprecated.static final IntegerDeprecated.static final IntegerDeprecated.static final IntegerDeprecated.static final IntegerDeprecated.static final IntegerDeprecated.static final IntegerDeprecated.static final IntegerDeprecated.static final IntegerDeprecated. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionInteger[]Deprecated.Get the actions that the user can do on this forum.Integer[]Deprecated.Get the actions that the user can do on this message.Integer[]Deprecated.Get the actions that the user can do on this thread.Deprecated.Get the user name of the message's author.doubleDeprecated.Get the rating of this message.getBody()Deprecated.Get the body for this message.Deprecated.Set the location of this body.Deprecated.Get the date-time this message was posted.intgetDepth()Deprecated.Get the depth of the message.Deprecated.Get theGlobalIdfor the forum containing the message.Deprecated.Get theGlobalIdof the message.Deprecated.Get theGlobalIdof the message's parent message.intDeprecated.Get the count of ratings for this message.Deprecated.Get the subject of this message.Deprecated.Get theGlobalIdfor the thread containing this message.booleanDeprecated.Determine if the author of the message is anonymous.booleanDeprecated.Determine whether this thread is sponsored.voidsetAllowedForumActions(Integer[] allowedForumActions_) Deprecated.Set the actions that the user can do on this forum.voidsetAllowedMessageActions(Integer[] allowedMessageActions_) Deprecated.Set the actions that the user can do on this message.voidsetAllowedThreadActions(Integer[] allowedThreadActions_) Deprecated.Set the actions that the user can do on this thread.voidsetAnonymousAuthor(boolean anonymous_) Deprecated.Set whether the author of this message is anonymous.voidDeprecated.Set the user name of the message's author.voidsetAverageRating(double rating_) Deprecated.Set the rating of this message.voidDeprecated.Set the body for this message.voidsetBodyLocation(String filename_) Deprecated.Get the location of this body.voidsetDatePosted(Timestamp time_) Deprecated.Set the date-time this message was posted.voidsetDepth(int depth_) Deprecated.Set the depth of the message.voidsetForumId(GlobalId forumId_) Deprecated.Set theGlobalIdfor the forum containing the message.voidsetMessageId(GlobalId messageId_) Deprecated.Set theGlobalIdof the message.voidsetParentId(GlobalId parentId_) Deprecated.Set theGlobalIdof the message's parent message.voidsetRatingCount(int ratingCount_) Deprecated.Set the count of ratings for this message.voidsetSponsored(boolean sponsored_) Deprecated.Set whether this thread is sponsored.voidsetSubject(String subject_) Deprecated.Set the subject of this message.voidsetThreadId(GlobalId threadId_) Deprecated.Set theGlobalIdfor the thread containing this message.
-
Field Details
-
SORT_BY_DEPTH
Deprecated. -
SORT_BY_AUTHOR
Deprecated. -
SORT_BY_ANONYMOUS_AUTHOR
Deprecated. -
SORT_BY_DATE_POSTED
Deprecated. -
SORT_BY_SUBJECT
Deprecated. -
SORT_BY_AVERAGE_RATING
Deprecated. -
SORT_BY_RATING_COUNT
Deprecated. -
SORT_BY_BODY_LOCATION
Deprecated. -
SORT_BY_SPONSORED
Deprecated.
-
-
Constructor Details
-
ThreadedMessage
public ThreadedMessage()Deprecated.
-
-
Method Details
-
getMessageId
Deprecated.Get theGlobalIdof the message.- Returns:
- The
GlobalId.
-
setMessageId
Deprecated.Set theGlobalIdof the message.- Parameters:
messageId_-
-
getParentId
Deprecated.Get theGlobalIdof the message's parent message.- Returns:
- The parent's
GlobalId.
-
setParentId
Deprecated.Set theGlobalIdof the message's parent message.- Parameters:
parentId_-
-
getDepth
public int getDepth()Deprecated.Get the depth of the message. SeeMessagefor a definition of depth.- Returns:
- The depth.
-
setDepth
public void setDepth(int depth_) Deprecated.Set the depth of the message. SeeMessagefor a definition of depth.- Parameters:
depth_-
-
getAuthor
Deprecated.Get the user name of the message's author.- Returns:
- The author's user name.
-
setAuthor
Deprecated.Set the user name of the message's author.- Parameters:
author_- the author to set
-
isAnonymousAuthor
public boolean isAnonymousAuthor()Deprecated.Determine if the author of the message is anonymous.- Returns:
trueif the author is anonymous;falseotherwise.
-
setAnonymousAuthor
public void setAnonymousAuthor(boolean anonymous_) Deprecated.Set whether the author of this message is anonymous.- Parameters:
anonymous_-
-
getDatePosted
Deprecated.Get the date-time this message was posted.- Returns:
- The date-time.
-
setDatePosted
Deprecated.Set the date-time this message was posted.- Parameters:
time_-
-
getSubject
Deprecated.Get the subject of this message.- Returns:
- The subject.
-
setSubject
Deprecated.Set the subject of this message.- Parameters:
subject_-
-
getBody
Deprecated.Get the body for this message.- Returns:
- The body.
-
setBody
Deprecated.Set the body for this message.- Parameters:
body_-
-
getAverageRating
public double getAverageRating()Deprecated.Get the rating of this message.- Returns:
- The rating.
-
setAverageRating
public void setAverageRating(double rating_) Deprecated.Set the rating of this message.- Parameters:
rating_-
-
getRatingCount
public int getRatingCount()Deprecated.Get the count of ratings for this message.- Returns:
- The number of ratings.
-
setRatingCount
public void setRatingCount(int ratingCount_) Deprecated.Set the count of ratings for this message.- Parameters:
ratingCount_-
-
getBodyLocation
Deprecated.Set the location of this body. SeeMessage.- Returns:
- The body's location.
-
setBodyLocation
Deprecated.Get the location of this body. SeeMessage.- Parameters:
filename_-
-
getThreadId
Deprecated.Get theGlobalIdfor the thread containing this message.- Returns:
- The thread's
GlobalId.
-
setThreadId
Deprecated.Set theGlobalIdfor the thread containing this message.- Parameters:
threadId_-
-
isSponsored
public boolean isSponsored()Deprecated.Determine whether this thread is sponsored.- Returns:
trueif this thread is sponsored;falseotherwise.
-
setSponsored
public void setSponsored(boolean sponsored_) Deprecated.Set whether this thread is sponsored.- Parameters:
sponsored_-
-
getForumId
Deprecated.Get theGlobalIdfor the forum containing the message.- Returns:
- The forum
GlobalId.
-
setForumId
Deprecated.Set theGlobalIdfor the forum containing the message.- Parameters:
forumId_-
-
getAllowedForumActions
Deprecated.Get the actions that the user can do on this forum.- Returns:
- An array of the actions.
-
setAllowedForumActions
Deprecated.Set the actions that the user can do on this forum.- Parameters:
allowedForumActions_- An array of the actions.
-
getAllowedMessageActions
Deprecated.Get the actions that the user can do on this message.- Returns:
- An array of the actions.
-
setAllowedMessageActions
Deprecated.Set the actions that the user can do on this message.- Parameters:
allowedMessageActions_- An array of the actions.
-
getAllowedThreadActions
Deprecated.Get the actions that the user can do on this thread.- Returns:
- An array of the actions.
-
setAllowedThreadActions
Deprecated.Set the actions that the user can do on this thread.- Parameters:
allowedThreadActions_- An array of the actions.
-