Jive Forums API (5.5.20.2-oracle) Core Javadocs

Uses of Interface
com.jivesoftware.base.User

Packages that use User
com.jivesoftware.base Base APIs and classes for Jive Software products. 
com.jivesoftware.base.event Base events common to all Jive Software products. 
com.jivesoftware.forum Core interfaces and classes for Jive Forums. 
com.jivesoftware.profiles   
com.jivesoftware.profiles.formatter   
com.jivesoftware.profiles.search   
com.jivesoftware.profiles.validator   
 

Uses of User in com.jivesoftware.base
 

Subinterfaces of User in com.jivesoftware.base
 interface IntrospectiveUser
          This User subinterface adds the ability to query what optional capabilities are supported in this User implementation.
 

Methods in com.jivesoftware.base that return User
 User UserManager.createUser(java.lang.String username, java.lang.String password, java.lang.String email)
          Factory method for creating a new User with all required values: a password, email address, and unique username.
 User UserManager.createUser(java.lang.String username, java.lang.String password, java.lang.String name, java.lang.String email, boolean nameVisible, boolean emailVisible, java.util.Map properties)
          Factory method for creating a new User with all required AND optional values.
 User Poll.getUser()
          Returns the user who created the poll or null if the poll was created anonymously.
 User Presence.getUser()
          Return the user owning the presence.
 User Roster.getUser()
          Returns the user that this roster belongs to.
 User UserManager.getUser(long userID)
          Returns a User specified by their ID.
 User UserManager.getUser(java.lang.String username)
          Returns the User specified by username.
 User AdvancedUserManager.getUserFromEmailAddress(java.lang.String email)
          Returns a user object corresponding to the email address given.
 

Methods in com.jivesoftware.base with parameters of type User
 void Group.addAdministrator(User user)
          Grants administrator privileges of the group to a user.
 void Group.addMember(User user)
          Adds a member to the group.
 void Roster.addUser(User user)
          Add a user to the roster.
 void PermissionsManager.addUserPermission(User user, PermissionType permissionType, long permission)
          Add a permission of the specified PermissionType for the specified user.
 void Poll.addUserVote(int index, User user)
          Add a user vote for an option in the poll.
 void Poll.changeUserVote(int prevOptionIndex, int newOptionIndex, User user)
          Change a user vote.
 Poll PollManager.createPoll(int objectType, long objectID, User user, java.lang.String name)
          Create a new Poll.
 Presence PresenceManager.createPresence(User user, java.lang.String uid, java.lang.String IPAddress)
          Create a presence for a user.
 void UserManager.deleteUser(User user)
          Deletes a user.
 com.jivesoftware.util.LongList GroupManager.getGroupIDs(User user)
          Returns a list of group ids for all the groups that the user is a member of.
 Presence PresenceManager.getPresence(User user)
          Returns the presence for the user, or null if the user isn't online.
 Roster PresenceManager.getRoster(User user)
          Returns the user's roster.
 java.util.Iterator GroupManager.getUserGroups(User user)
          Returns an iterator for all groups that a user is a member of.
 java.util.List Poll.getUserVotes(User user)
          Returns a list of option indexes corresponding to the user votes, or an empty array if the user has not voted.
 boolean Poll.hasUserVoted(User user)
          Returns true if the user specified has previously voted in the poll, false otherwise.
 boolean Group.isAdministrator(User user)
          Returns true if the User has group administrator permissions.
 boolean Group.isMember(User user)
          Returns true if if the User is a member of the group.
 boolean PresenceManager.isOnline(User user)
          Returns whether the user is currently online or not.
 boolean Roster.isRosterMember(User user)
          Returns true if the specified user is a member of the roster, false otherwise.
static void Log.markDebugLogFile(User user)
           
static void Log.markErrorLogFile(User user)
           
static void Log.markInfoLogFile(User user)
           
static void Log.markWarnLogFile(User user)
           
 void Group.removeAdministrator(User user)
          Revokes administrator privileges of the group to a user.
 void Group.removeMember(User user)
          Removes a member from the group.
 void Roster.removeUser(User user)
          Remove a user from the roster.
 void PermissionsManager.removeUserPermission(User user, PermissionType permissionType, long permission)
          Removes a permission of the specified PermissionType for the specified user.
 void Poll.removeUserVote(int prevOptionIndex, User user)
          Remove a user vote.
 

Uses of User in com.jivesoftware.base.event
 

Methods in com.jivesoftware.base.event that return User
 User UserEvent.getUser()
           
 

Constructors in com.jivesoftware.base.event with parameters of type User
UserEvent(int eventType, User user, java.util.Map params)
           
 

Uses of User in com.jivesoftware.forum
 

Methods in com.jivesoftware.forum that return User
 User Query.getFilteredUser()
          Returns the user that query results are restricted to.
 User Avatar.getOwner()
          Returns user who created this avatar, if the user is null then this is a global avatar
 User PrivateMessageFolder.getOwner()
          Returns the owner of the private message folder.
 User PrivateMessage.getRecipient()
          Returns the user the message was sent to.
 User PrivateMessage.getSender()
          Returns the user the message was sent by, or null if the message was sent by the system.
 User Announcement.getUser()
          Returns the User that is the author of the announcemnt.
 User ForumMessage.getUser()
          Returns the User that authored this message.
 User JiveContentObject.getUser()
          Returns the user who authored of the jive object.
 User Query.getUser()
          Returns the user that is executing the search.
 User Watch.getUser()
          Returns the user who is associated with this watch.
 

Methods in com.jivesoftware.forum with parameters of type User
static void AvatarManagerFactory.addActiveAvatarToCache(Avatar avatar, User user)
          Adds an avatar to the active avatar caches for a specific user
 void RewardManager.addBankPoints(User user, int numPoints)
          Allows administrators to add or substract an arbitrary number of reward points from a user's point bank.
 void RatingManager.addRating(User user, ForumMessage message, Rating rating)
          Add a rating to the forum message.
 void RatingManager.addRating(User user, ForumThread thread, Rating rating)
          Add a rating to the forum thread.
 Announcement AnnouncementManager.createAnnouncement(User user)
          Creates a new system announcement.
 Announcement AnnouncementManager.createAnnouncement(User user, Forum forum)
          Creates a new forum announcement.
 Announcement AnnouncementManager.createAnnouncement(User user, ForumCategory category)
          Creates a new category announcement.
 Avatar AvatarManager.createAvatar(User owner, java.lang.String name, java.lang.String contentType, java.io.InputStream in)
          Creates a new avatar for a user allowing the user to specify an inputstream for the image.
 PrivateMessageFolder PrivateMessageManager.createFolder(User user, java.lang.String name)
          Creates a new folder.
 ForumMessage Forum.createMessage(User user)
          Factory method to create a message as the specified user.
 PrivateMessage PrivateMessageManager.createMessage(User sender)
          Creates a new private message.
 Watch WatchManager.createWatch(User user, Forum forum)
          Create a watch on a forum for the specified user.
 Watch WatchManager.createWatch(User user, ForumCategory category)
          Create a watch on a category for the specified user.
 Watch WatchManager.createWatch(User user, ForumThread thread)
          Create a watch on a thread for the specified user.
 Watch WatchManager.createWatch(User user, User watchedUser)
          Create a watch on a user for the specified user.
 void WatchManager.deleteWatches(User user)
          Deletes all watches that a user has.
 void Query.filterOnUser(User user)
          Restricts the query results to messages posted by a specified user.
 Avatar AvatarManager.getActiveAvatar(User user)
          Returns an avatar for a user, else null if no avatar exists for this user
 java.util.Iterator WatchManager.getAllWatches(User user, int objectType)
          Returns an iterator for all objects of a particular type that a user is watching.
 int AvatarManager.getAvatarCount(User user)
          Used to acquire a count of all the avatars for a specific user
 java.util.Iterator AvatarManager.getAvatars(User user)
          Returns a collection of avatars for a user
 int RewardManager.getBankPoints(User user)
          Returns the current number of reward points a user has.
 PrivateMessageFolder PrivateMessageManager.getFolder(User user, int folderID)
          Returns the specified folder for a user.
 int PrivateMessageManager.getFolderCount(User user)
          Returns the total number of folders the user has.
 java.util.Iterator PrivateMessageManager.getFolders(User user)
          Returns an Iterator of PrivateMessageFolder objects for the folders the user has.
 int PrivateMessageManager.getMessageCount(User user)
          Returns the total number of private messages a user has in their mailbox.
 java.util.Iterator RewardManager.getPendingRewardThreads(User user)
          Returns the threads (ordered by modified date) that the user has assigned points to that haven't been fully rewarded out yet.
 int RewardManager.getPendingRewardThreadsCount(User user)
          Returns a count of the threads that the user has assigned points to that haven't been fully rewarded out yet.
 int StatusLevelCalculator.getPointLevel(User user)
          Returns the point level for a user system wide.
 int StatusLevelManager.getPointLevel(User user)
          Returns the point level for a user system wide.
 int StatusLevelCalculator.getPointLevel(User user, Forum forum)
          Returns the status level points for a user in regards to a specific forum
 int StatusLevelManager.getPointLevel(User user, Forum forum)
          Returns the status level points for a user in regards to a specific forum
 int StatusLevelCalculator.getPointLevel(User user, ForumCategory category)
          Returns the status level points for a user in regards to a specific category
 int StatusLevelManager.getPointLevel(User user, ForumCategory category)
          Returns the status level points for a user in regards to a specific category
 int RewardManager.getPointsEarned(User user)
          Returns the total number of points that a user has earned across the entire system.
 int RewardManager.getPointsEarned(User user, Forum forum)
          Returns the total number of points the user has earned in a particular forum.
 int RewardManager.getPointsEarned(User user, ForumCategory category)
          Returns the total number of points the user has earned in a particular category.
 int RewardManager.getPointsRewarded(User user)
          Returns the total number of points that a user has ever rewarded.
 java.util.Iterator QueryLogger.getQueries(User user)
          Returns an Iterator consisting of all the Query's that the specified user has made.
 int QueryLogger.getQueryCount(User user)
          Returns a count of all the queries that the user has made.
 Rating RatingManager.getRating(User user, ForumMessage message)
          Returns the rating associated with the user, or null if this user hasn't rated the forum message.
 Rating RatingManager.getRating(User user, ForumThread thread)
          Returns the rating associated with the user, or null if this user hasn't rated the forum thread.
 int ReadTracker.getReadStatus(User user, ForumMessage message)
          Returns the read status on the specified message.
 int ReadTracker.getReadStatus(User user, ForumThread thread)
          Returns the read status on the specified thread.
 int WatchManager.getRecursiveForumWatchCount(User user, ForumCategory category)
          Returns number of Forum objects the user is watching under the category and its subcategories.
 java.util.Iterator WatchManager.getRecursiveForumWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns all the Forum objects the user is watching under the category and its subcategories.
 int WatchManager.getRecursiveThreadWatchCount(User user, ForumCategory category)
          Returns the number of ForumThread objects the user is watching under the provided ForumCategory.
 java.util.Iterator WatchManager.getRecursiveThreadWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns the ForumThread objects the user is watching under the provided ForumCategory.
 StatusLevel StatusLevelManager.getStatusLevel(User user)
          Returns the system wide status level for specific user, will return null if there is no status level for this user.
 StatusLevel StatusLevelManager.getStatusLevel(User user, Forum forum)
          Returns the status level for a user in a specific forum. if a status level cannot be determined for this user in this forum null will be returned.
 StatusLevel StatusLevelManager.getStatusLevel(User user, ForumCategory category)
          Returns the status level for a user in a specific category. if a status level cannot be determined for this user in this category null will be returned.
 java.util.Iterator WatchManager.getThreadWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns the ForumThread objects the user is watching under the provided ForumCategory.
 int WatchManager.getTotalWatchCount(User user, int objectType)
          Returns a count of all watches that a user has of a particular type.
 int PrivateMessageManager.getUnreadMessageCount(User user)
          Returns the total number of unread private messages a user has in their mailbox.
 int ReadTracker.getUnreadMessageCount(User user, Forum forum)
          Returns the count of unread messages that the user has in the forum.
 int ReadTracker.getUnreadMessageCount(User user, ForumCategory category)
          Returns the count of unread messages that the user has in the category.
 java.util.Iterator ReadTracker.getUnreadMessages(User user, Forum forum)
          Returns an iterator for the unread messages in the forum.
 java.util.Iterator ReadTracker.getUnreadMessages(User user, ForumCategory category)
          Returns an iterator for the unread messages in the category.
 int ReadTracker.getUnreadThreadCount(User user, Forum forum)
          Returns the count of unread threads that the user has in the forum.
 int ReadTracker.getUnreadThreadCount(User user, ForumCategory category)
          Returns the count of unread threads that the user has in the category.
 java.util.Iterator ReadTracker.getUnreadThreads(User user, Forum forum)
          Returns an iterator for the unread threads in the forum.
 java.util.Iterator ReadTracker.getUnreadThreads(User user, ForumCategory category)
          Returns an iterator for the unread threads in the category.
abstract  int ForumFactory.getUserMessageCount(User user)
          Returns the total number of messages a user has posted in all forums.
abstract  int ForumFactory.getUserMessageCount(User user, ResultFilter resultFilter)
          Returns the total number of messages a user has posted in all forums that obey the parameters set by the specificed ResultFilter.
abstract  java.util.Iterator ForumFactory.getUserMessages(User user)
          Returns an iterator for all messages posted by a user.
abstract  java.util.Iterator ForumFactory.getUserMessages(User user, ResultFilter resultFilter)
          Returns an iterator for all messages posted by a user that obey the parameters set by the specified ResultFilter.
 Watch WatchManager.getWatch(User user, Forum forum)
          Returns a watch on a particular forum, or null if there isn't a watch.
 Watch WatchManager.getWatch(User user, ForumCategory category)
          Returns a watch on a particular category, or null if there isn't a watch.
 Watch WatchManager.getWatch(User user, ForumThread thread)
          Returns a watch on a particular thread, or null if there isn't a watch.
 Watch WatchManager.getWatch(User user, User watchedUser)
          Returns a watch on a particular thread, or null if there isn't a watch.
 int WatchManager.getWatchCount(User user, Forum forum)
          Return the count of all thread watches in a particular forum for the given user.
 int WatchManager.getWatchCount(User user, ForumCategory category)
          Return the count of all forum watches in a particular category for the given user.
 java.util.Iterator WatchManager.getWatches(User user, Forum forum)
          Returns an Iterator for all the thread objects a user is watching in a forum.
 java.util.Iterator WatchManager.getWatches(User user, ForumCategory category)
          Returns an Iterator for all the forum objects a user is watching in a category.
 java.util.Iterator WatchManager.getWatches(User user, ForumCategory category, int startIndex, int numResults)
          Returns the Forums watched by the User under the given Category.
 java.util.Iterator WatchManager.getWatches(User user, Forum forum, int startIndex, int numResults)
          Returns all the ForumThreads watched by the User under the given Forum.
 Watch[] WatchManager.getWatchList(User user, int objectType)
          Returns an array of Watch objects for a particular object type that the given user is watching.
 boolean RatingManager.hasRated(User user, ForumMessage message)
          Returns whether the user has rated the forum message or not.
 boolean RatingManager.hasRated(User user, ForumThread thread)
          Returns whether the user has rated the forum thread or not.
 boolean WatchManager.isWatched(User user, Forum forum)
          Returns true if the user is watching the specified forum.
 boolean WatchManager.isWatched(User user, ForumCategory category)
          Returns true if the user is watching the specified category.
 boolean WatchManager.isWatched(User user, ForumThread thread)
          Returns true if the user is watching the specified thread.
 boolean WatchManager.isWatched(User user, User watchedUser)
          Returns true if the user is watching the specified user.
 long Query.logQuery(User user)
          Logs the query for later statistical analysis.
 void ReadTracker.markRead(User user, Forum forum)
          Marks an entire forum as read up until the current instant in time.
 void ReadTracker.markRead(User user, ForumCategory category)
          Marks an entire category as read up until the current instant in time.
 void ReadTracker.markRead(User user, ForumMessage message)
          Marks an individual message as read.
 PrivateMessage PrivateMessageManager.sendMessage(PrivateMessage privateMessage, User recipient, boolean copyToSentFolder)
          Sends a private message to another user.
 void AvatarManager.setActiveAvatar(User user, Avatar avatar)
          Used to make a user use a global avatar, to set no active avatar pass null for the avatar value.
 

Uses of User in com.jivesoftware.profiles
 

Methods in com.jivesoftware.profiles that return User
 User ProfileEvent.getUser()
           
 

Constructors in com.jivesoftware.profiles with parameters of type User
ProfileEvent(int eventType, User user)
           
 

Uses of User in com.jivesoftware.profiles.formatter
 

Methods in com.jivesoftware.profiles.formatter with parameters of type User
 java.lang.String ProfileFieldFormatter.format(java.lang.String value, User user)
          Format a profile field for display to the end user with the given AuthToken.
 

Uses of User in com.jivesoftware.profiles.search
 

Methods in com.jivesoftware.profiles.search with parameters of type User
 void ProfileSearchManager.addToIndex(User user)
          Adds an individual user to the index.
 void ProfileSearchManager.removeFromIndex(User user)
          Removes an individual user from the index.
 

Uses of User in com.jivesoftware.profiles.validator
 

Methods in com.jivesoftware.profiles.validator with parameters of type User
 java.lang.String ProfileFieldValidator.validate(java.lang.String value, User user)
          Performs field validation on user supplied input.
 


Jive Forums Project Page

Copyright © 1999-2006 Jive Software.