|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTCommunityManager
Method Summary | |
---|---|
IPTCommunityInfo |
CachedOpenCommunityInfo(int nCommunityID,
boolean bCheckLastModified)
Returns an IPTCommunityInfo, which can be used by the UI to display a cached version of the community. |
void |
FlushMandatoryTabsCache()
Flush the mandatory tabs cache. |
void |
FlushObjectIdLookupCache()
Flush the object name to object id cache. |
int |
GetCommunityIDGivenPageID(int nPageID)
Returns the community id of the community which owns passed in page id. |
void |
JoinCommunity(int nCommunityID,
int nMembershipType)
Join the current user to a community with a particular membership type. |
int |
LookupPageIdFromCommunityPageName(int commId,
java.lang.String pageName)
Looksup the page id or page ids if there are more than one page with the specified name in the specified community. |
IPTQueryResult |
QueryAvailableCommunities()
Query for communities that are available to the current user. |
IPTQueryResult |
QueryCommunitiesForGadget(int nGadgetID)
Returns a query result of object IDs for the communities that contain the given gadget. |
IPTQueryResult |
QueryMandatoryTabs()
Query for current user's list of mandatory communities that appear with navigation tabs. |
IPTQueryResult |
QueryMemberships()
Query for the current user's community memberships, which includes communities that the user has joined and communities that are mandatory for groups that the user is in. |
void |
QuitCommunity(int nCommunityID)
Remove the current user from a community that they are currently joined to. |
Method Detail |
---|
IPTCommunityInfo CachedOpenCommunityInfo(int nCommunityID, boolean bCheckLastModified)
nCommunityID
- ID of the Community to openbCheckLastModified
- Checks the last modified date of the Community in the DB and
loads a fresh entry to cache if the Community info in the cache
is old.
IPTQueryResult QueryCommunitiesForGadget(int nGadgetID)
nGadgetID
- ID of the gadget to query for.
PT_PROPIDS
int GetCommunityIDGivenPageID(int nPageID)
nPageID
- ID of the page
IPTQueryResult QueryMemberships()
IPTQueryResult QueryAvailableCommunities()
void JoinCommunity(int nCommunityID, int nMembershipType)
nCommunityID
- - community id to joinnMembershipType
- - of type PT_COMMUNITY_MEMBERSHIPTYPEvoid QuitCommunity(int nCommunityID)
nCommunityID
- - community id to quitIPTQueryResult QueryMandatoryTabs()
void FlushMandatoryTabsCache()
void FlushObjectIdLookupCache()
int LookupPageIdFromCommunityPageName(int commId, java.lang.String pageName)
commId
- The id of the community to lookup the specified page namepageName
- Page name to lookup
PTException
- with result code PT_RESULTCODES.PT_E_FAIL
if the community is not accessible
or if the page is not accessible by the user or not found
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |