Tree.getNodesByLinkReference (Method)
Returns information about navigation tree nodes that link to the page with the passed pageID.
Returns:
MultipleTreeNodeListResult (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CanAdmin | Boolean | Flag indicating whether the current user an administer the tree this node belongs to. |
| CanEdit | Boolean | Flag indicating whether the current user an edit the tree this node belongs to. |
| NodeDescription | PlainText_2000 | Description of this node. |
| NodeID | TreeNodeID | ID of this node. |
| NodeState | ActiveInactive | State of this node, Active or Inactive. |
| NodeTitle | PlainText_NonNull_255 | Title of this node. |
| TreeDescription | PlainText_2000 | Description of the tree this node belongs to. |
| TreeFamily | PlainText_NonNull_50 | Family of the tree this node belongs to. |
| TreeFamilyID | TreeFamilyID | ID of the tree family for this node. |
| TreeID | TreeID | ID of the tree this node belongs to. |
| TreeName | TreeName | Name of the tree this node belongs to. |
| TreeState | ActiveInactive | State of the tree this node belongs to, Active or Inactive. |
| TreeType | PlainText_NonNull_100 | Type of the tree this node belongs to. |
| TreeTypeDescription | PlainText_2000 | Description of the tree type this node belongs to. |
| TreeTypeID | TreeTypeID | ID of the tree type for this node. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageID | PageID | Required | ID of the page you want to search for links to. |
| treeNameFilter | PlainText | Optional. Defaults to an empty string. | Tree name to filter the results by, or empty string for all trees. |
| nodeTitleFilter | PlainText | Optional. Defaults to an empty string. | Node title to filter the results by. |
| typeIDFilter | TreeTypeID_0 | Optional. Defaults to '0'. | ID of tree type to filter the results to. |
| familyIDFilter | TreeFamilyIDFilter | Optional. Defaults to 'All'. | ID of tree family to filter results to, or All. |
| stateFilter | GeneralStateFilter | Optional. Defaults to 'All'. | Optional state filter to restrict the results to. If 'Active' or 'Inactive', both the node and its parent tree must be in the requested state. |
Context:
| License Requirements | (none) |
| Permission Requirements | (none) |
| Deny Context | (none) |
| Require Context | (none) |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None