Plumtree EDK (Enterprise Web Development Kit) 5.4.0

IPortletRequest.GetLoginToken Method 

Returns the user’s login token from the request.

string GetLoginToken();

Return Value

the login token

Remarks

The login token can be used to access the portal as the current user. To instantiate an IRemoteSession object, use IPortletContext.GetRemotePortalSession(). Note: The login token is new functionality in version 5.0; this method throws ProtocolNotSupportedException when used with any prior version of the portal.

Exceptions

Exception Type Condition
NotGatewayedException if the request is not gatewayed
ProtocolNotSupportedException if used with a version of the portal earlier than 5.0
NotInRequestException if the administrator has not configured the portal to send the login token to this Portlet

See Also

IPortletRequest Interface | Plumtree.Remote.Portlet Namespace