|
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 |
public interface DraftManager
Manages the draft features of Jive Forums. The following Jive properties correspond to the draft manager settings:
ForumFactory.getDraftManager()
Method Summary | |
---|---|
Draft |
createDraft(Draft draft)
Creates a new draft. |
void |
deleteDraft(Draft draft)
Delete an existing draft. |
int |
getAutosaveInterval()
Returns the setting for the number of seconds between autosave invocations when autosave is enabled for a text field. |
Draft |
getDraft(long draftID)
Returns a draft by draft ID or null if no draft exists with the specified draftID. |
Draft |
getDraft(long userid,
int drafttype,
int objectType,
long objectID)
Returns the draft for a particular user associated with a particular forum, thread and / or message. |
java.util.Iterator |
getDraftsByUser(long userid)
Returns all drafts for a particular user. |
boolean |
isAutosaveEnabled()
Determines whether or not the system has been configured to allow for autosave in text fields. |
void |
setAutosaveEnabled(boolean enable)
Enables or disables autosave. |
void |
setAutosaveInterval(int interval)
Sets the amount of time (in seconds) that the browser should wait between updating the draft. |
void |
updateDraft(Draft draft)
Update an existing draft. |
Methods inherited from interface com.jivesoftware.base.JiveManager |
---|
destroy, initialize |
Method Detail |
---|
Draft createDraft(Draft draft)
draft
- a Draft
Draft getDraft(long draftID) throws UnauthorizedException
draftID
- the ID of the draft to return.
UnauthorizedException
- if the user is not either a System Admin
or the user associated with the draft.Draft getDraft(long userid, int drafttype, int objectType, long objectID)
userid
- the user to find draft fordrafttype
- the draft type to filter the results byobjectType
- the type of container to filter byobjectID
- the id of a specific container to filter by
java.util.Iterator getDraftsByUser(long userid)
userid
- the id of the user
void updateDraft(Draft draft) throws UnauthorizedException
draft
- The draft to be updated.
UnauthorizedException
- if the user associated with the draft is
not either a system admin or the owner of the draft.void deleteDraft(Draft draft) throws UnauthorizedException
draft
- The draft to be deleted.
UnauthorizedException
- if the user associated with the draft is
not either a system admin or the owner of the draft.boolean isAutosaveEnabled()
void setAutosaveEnabled(boolean enable)
enable
- int getAutosaveInterval()
void setAutosaveInterval(int interval)
interval
-
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |