Returns the remote API endpoint from the portal request.
The remote API endpoint or null if the portlet is run as a job.
The remote API endpoint can be used to access the portal's remote SOAP API. To instantiate an IRemoteSession object, use IPortletContext.GetRemotePortalSession(). Note: The remote API endpoint is new functionality in portal version 5.0; this method throws ProtocolNotSupportedException when used with any prior version of the portal.
| Exception Type | Condition |
|---|---|
| NotGatewayedException | The request is not gatewayed. |
| ProtocolNotSupportedException | Used with a version of the portal earlier than 5.0. |
IGenericRequest Interface | Plumtree.Remote.Portlet Namespace