Class Index | File Index

Classes


Class sap.ushell.cpv2.services.cloudServices.SiteService

SiteService
Defined in: SiteService.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Gets the navigation target of the current app/page
 
getMenuHierarchy(menu, payload)
Gets the menu hierarchy
 
Returns the settings of the current page.
 
Returns the ID of the current site.
 
Returns the settings of the site.
 
Returns true if the site is running in design time mode.
 
Returns true if the site is running in preview mode (of SAP Web IDE)
 
Returns true if the site is running in runtime mode.
 
savePageSettings(settings)
Saves the settings of the current page.
 
saveSiteSettings(settings)
Saves the settings of the site.
 
Subscribes to navigation event
 
Unsubscribes from navigation event
Class Detail
sap.ushell.cpv2.services.cloudServices.SiteService()
Method Detail
{*} getCurrentAppTarget()
Gets the navigation target of the current app/page
Returns:
{*}

{*} getMenuHierarchy(menu, payload)
Gets the menu hierarchy
Parameters:
menu
payload
Returns:
{*}

{*} getPageSettings()
Returns the settings of the current page.
Returns:
{*}

{String} getSiteID()
Returns the ID of the current site.
Returns:
{String}

{*} getSiteSettings()
Returns the settings of the site.
Returns:
{*}

{boolean} isDesignTime()
Returns true if the site is running in design time mode.
Returns:
{boolean}

{boolean} isPreview()
Returns true if the site is running in preview mode (of SAP Web IDE)
Returns:
{boolean}

{boolean} isRuntime()
Returns true if the site is running in runtime mode.
Returns:
{boolean}

{*} savePageSettings(settings)
Saves the settings of the current page. To enable editing of the site settings via the Custom Site Properties editor in the Admin Space, use a key:value pair, where the key name is unique for the site, and the value is a string, number or a Boolean. The property value cannot be an array, an object or a null.
Parameters:
settings
Returns:
{*}

{*} saveSiteSettings(settings)
Saves the settings of the site.
Parameters:
settings
Returns:
{*}

subscribeOnAppNavigation(fn)
Subscribes to navigation event
Parameters:
fn
- function to be called

unsubscribeOnAppNavigation(fn)
Unsubscribes from navigation event
Parameters:
fn
- function to be unsubsribed

©Copyright (c) 2009-2014 SAP SE, All Rights Reserved
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 02 2017 06:47:58 GMT-0000 (UTC)