WebCenter Interaction API  
 

IPTMyPortal Members

IPTMyPortal overview

Public Instance Methods

public methodAddCommunitySettingOverloaded. Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.
public methodAddGadget Add one gadget to the page that this IPTMyPortal represents. This is a legacy method, so AddGadgetEx should be used instead.
public methodAddGadgetEx Add a gadget to a column on the page that this IPTMyPortal represents. It adds this gadget to the gadgets that are already in this column.
public methodAddPersonalSettingOverloaded. Add a personal setting (preference) for the current user.
public methodAddSessionPreference Adds a session preference for the current user. This information is cached and not persisted to the database.
public methodAssignCommunityGadgetSettings Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of and a particular gadget. Calling this function will delete all the old settings for this community-gadget combination. Throws an exception if the current page is a my page.
public methodAssignCommunityGadgetSettingsEx Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of and a particular gadget. Throws an exception if the current page is a my page.
public methodAssignGadgetSettings Assign a list of user-gadget settings (preferences) to the combination of a particular gadget and the current user. Calling this function will delete all the old settings for this gadget and user.
public methodAssignGadgetSettingsEx Assign a list of user-gadget settings (preferences) to the combination of a particular gadget and the current user.
public methodAssignGadgetsExOverloaded. Assign a list of gadgets to a column on the page that this IPTMyPortal represents. It adds this list to the gadgets that are already in this column.
public methodGetCommunityID Get the community id of the community that the current page is part of. Returns 0 if the current page is a my page.
public methodGetCommunityName Get the community name of the community that the current page is part of. Returns empty string the current page is a my page.
public methodGetPageID Get the Page ID of the page that this IPTMyPortal represents.
public methodGetPageName Get the Page name of the page that this IPTMyPortal represents.
public methodGetPageType Get the type of the page that this IPTMyPortal represents.
public methodGetURL Get the URL (page type) of the page that this IPTMyPortal represents. Throws an exception if the current page is a my page. This function will be removed.
public methodLookupCommunityGadgetSettingsOverloaded. Look up community-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget id that is passed in. Throws an exception if the current page is a my page.
public methodLookupCommunitySettingsOverloaded. Look up community settings (preferences) for the community that the current page is part of. Throws an exception if the current page is a my page.
public methodLookupGadgetSettingsOverloaded. Look up a list of user-gadget settings (preferences) for the combination of a particular gadget and the current user.
public methodLookupPersonalSettingsOverloaded. Look up a list of personal settings (preferences) for the current user.
public methodLookupSessionPreference This method looks up a preference set for the current user.
public methodLookupSessionPreferences This method looks up session preferences set for the current user.
public methodQueryGadgetContent Query for the all of the gadget content on the page that this IPTMyPortal represents.
public methodQueryGadgets Query for all the gadgets on the page that this IPTMyPortal represents.
public methodRemoveCommunityGadgetSetting Remove a community-gadget setting (preference) from the combination of the community that the current page is part of and a particular gadget. Throws an exception if the current page is a my page.
public methodRemoveCommunitySetting Remove a community setting (preference) for the community that the current page is part of. Throws an exception if the current page is a my page.
public methodRemoveGadget Remove one gadget from the page that this IPTMyPortal represents.
public methodRemoveGadgetSetting Remove a user-gadget setting (preference) for the combination of a particular gadget and the current user.
public methodRemovePersonalSetting Remove a personal setting (preference) for the current user.
public methodRemoveSessionPreference Removes a session preference for the current user. This information is cached.

See Also

IPTMyPortal Interface | com.plumtree.server Namespace