Class Index | File Index

Classes


Namespace NavigationHandle

A handle for navigation functionality.
Defined in: shell.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
NavigationHandle.navigateToUrl(sUrl, mSettings)
Navigates to the target described by the given URL.
Namespace Detail
NavigationHandle
Since:
1.2.0
Method Detail
<static> NavigationHandle.navigateToUrl(sUrl, mSettings)
Navigates to the target described by the given URL. In addition to launchpad URLs (since 1.2.0), absolute and relative HTTP URLs (since 1.8.1) are supported as well. Supported URLs start with sap-lpd:, https://, http://, /, ./ or ../.
Parameters:
{string} sUrl
URL, e.g. "sap-lpd:04TEST03NAV20005056A207351ED1A28D1BE7494F98C9"
{object} mSettings Optional
Settings object that holds all optional parameters (since 1.8.1).
{boolean} mSettings.forwardSapParameters Optional
If true, any URL parameter of the calling application from the SAP namespace sap-* (e.g. sap-language) will be appended to the target URL. Already existing parameters in the target URL remain unchanged. This setting is not considered for OBN navigation.
{boolean} mSettings.launchInplace Optional
If true, the navigation happens in-place. This setting is not considered for launchpad navigation. This parameter will be overwritten in case of sap-lpd URLs.
{boolean} mSettings.shellHosted Optional
If true, an external window contains a shell. Will only be interpreted if mSettings.launchInplace is false and EPCM is available (NWBC, Portal). This parameter will be overwritten in case of sap-lpd URLs.
{string} mSettings.shellVisibility Optional
Can contain the values "FULL" and "MINIMAL" and determines the visibility of the shell. Will only be interpreted if mSettings.shellHosted is true and EPCM is available (NWBC, Portal). This parameter will be overwritten in case of sap-lpd URLs.
Since:
1.2.0

©Copyright (c) 2009-2014 SAP SE, All Rights Reserved
Documentation generated by JsDoc Toolkit 2.4.0 on Fri Sep 04 2015 02:52:17 GMT+0200 (MESZ)