Plumtree EDK (Enterprise Web Development Kit) 5.4.0

IPortletRequest Members

IPortletRequest overview

Public Instance Methods

GetAggregationMode Returns the current AggregationMode for the Portlet.
GetAlignment Returns the alignment of the portlet.
GetBasicAuthPassword Returns the password from the HTTP Authorization header in the web request.
GetBasicAuthUsername Returns the username from the HTTP Authorization header in the web request.
GetClassID Returns the class ID.
GetCommunityID Returns the ID of the Community in which the Portlet is currently displayed.
GetEncryptedSettingValue Gives the value for any portal preference.
GetGatewayConfigValue Returns the requested value from the CSP-Gateway-Specific-Config header.
GetHostPageURI Returns the URI for the portal page in which the Portlet is currently displayed.
GetHostPageURLQueryString Gets the query string portion of the URL that was used to access this portal's hosting page.
GetImageServerURI Returns the URI for the portal Image Server.
GetLoginToken Returns the user’s login token from the request.
GetPageID Returns the ID of the portal page on which the Portlet is currently displayed.
GetPortalUUID Returns the portal UUID.
GetPortletID Returns the Portlet ID for the current Portlet.
GetPortletMode Returns a PortletMode object to tell the client what mode the Portlet is running in.
GetProtocolVersion Returns the current version of the protocol being used by the portal to communicate with this Portlet.
GetRemoteAPIEndpoint Returns the remote API endpoint from the portal request.
GetReturnURI Returns the URI for the portal page to return to when done.
GetSettingCollection Returns a dictionary of all settings of the referenced setting type.
GetSettingValue Gives the value for any portal preference.
GetStylesheetURI Returns the URI for the stylesheet currently being used by the portal user.
GetSubPortalID Returns the ID of the subportal that the accessing user belongs to.
GetTimeZone Returns a TimeZone object representing the end user's time zone.
GetUserInterface Returns a UserInterface object to tell the client what type of device is being used to browse the portal (e.g., phone, PDA, standard Web browser).
HasBasicAuth Returns whether the request has basic auth.
HasTimeZone Returns a boolean indicating whether the time zone is available in the request headers.
IsGatewayed Checks if the request is gatewayed.
IsInCommunity Checks if Portlet is currently displayed in a Community page.

See Also

IPortletRequest Interface | Plumtree.Remote.Portlet Namespace