Show TOC

getNavigationSubTree MethodLocate this document in the navigation structure

Use

getNavigationSubTree(name, callback, argument)

Returns an array of child nodes of the specified navigation node along with their subtrees.

Parameter

Description

name

The ID of the navigation node whose child nodes are to be returned. If set to null, the initial (top-level) nodes are returned.

callback

A callback function to return the result. The callback function receives the following parameters:

Nodes: An array of NavigationNode objects representing the children of the specified navigation node. If the node ID is set to null, the initial (top-level) nodes are returned.

Additional Parameter: The additional parameter passed to the getNavigationSubTree() method.

argument (optional)

Any JavaScript object. The object is passed to the callback function.

Return Value

None; the result is returned asynchronously through the callback function.

Example

Sample Code 
var childrenArray = EPCM.getSAPTop().LSAPI.AFPPlugin.model.getNavigationSubTree(node.getName(), callbackFunctionName, {arg1:value1, arg2:value2});