Aqualogic Interaction API  
 

IPTMyPortal Members

IPTMyPortal overview

Public Instance Methods

AddCommunitySettingOverloaded. 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.
AddGadget Add one gadget to the page that this IPTMyPortal represents. This is a legacy method, so AddGadgetEx should be used instead.
AddGadgetEx 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.
AddPersonalSettingOverloaded. Add a personal setting (preference) for the current user.
AddSessionPreference Adds a session preference for the current user. This information is cached and not persisted to the database.
AssignCommunityGadgetSettings 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.
AssignCommunityGadgetSettingsEx 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.
AssignGadgetSettings 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.
AssignGadgetSettingsEx Assign a list of user-gadget settings (preferences) to the combination of a particular gadget and the current user.
AssignGadgetsExOverloaded. 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.
GetCommunityID Get the community id of the community that the current page is part of. Returns 0 if the current page is a my page.
GetCommunityName Get the community name of the community that the current page is part of. Returns empty string the current page is a my page.
GetPageID Get the Page ID of the page that this IPTMyPortal represents.
GetPageName Get the Page name of the page that this IPTMyPortal represents.
GetPageType Get the type of the page that this IPTMyPortal represents.
GetURL 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.
LookupCommunityGadgetSettingsOverloaded. 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.
LookupCommunitySettingsOverloaded. 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.
LookupGadgetSettingsOverloaded. Look up a list of user-gadget settings (preferences) for the combination of a particular gadget and the current user.
LookupPersonalSettingsOverloaded. Look up a list of personal settings (preferences) for the current user.
LookupSessionPreference This method looks up a preference set for the current user.
LookupSessionPreferences This method looks up session preferences set for the current user.
QueryGadgetContent Query for the all of the gadget content on the page that this IPTMyPortal represents.
QueryGadgets Query for all the gadgets on the page that this IPTMyPortal represents.
RemoveCommunityGadgetSetting 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.
RemoveCommunitySetting 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.
RemoveGadget Remove one gadget from the page that this IPTMyPortal represents.
RemoveGadgetSetting Remove a user-gadget setting (preference) for the combination of a particular gadget and the current user.
RemovePersonalSetting Remove a personal setting (preference) for the current user.
RemoveSessionPreference Removes a session preference for the current user. This information is cached.

See Also

IPTMyPortal Interface | com.plumtree.server Namespace