GetBreadcrumbs
Mon 01 January 2018Syntax
GetBreadcrumbs()
Description
Note: This function has been deprecated and is retained for backward compatibility only.
Use the GetBreadcrumbs function to return the userâs current history stack as an array of array of string in reverse order of accessâthat is, the first history record in the list represents the current content reference. The array of string includes 11 elements as specified in the following table. Specific values are included in the table when they do not vary based on the breadcrumb type; otherwise, blank cells indicate values that are dependent on the specific breadcrumb. For example, breadcrumbs created by PeopleTools do not include certain values such as a page ID or component keys. These and any other unknown values are returned as the literal string âUnknownValueâ.
|
Data Element |
Breadcrumb Generated by CreateBreadcrumb |
Content Breadcrumb Generated by PeopleTools |
Folder Breadcrumb Generated by PeopleTools |
|---|---|---|---|
|
Element type |
C |
C |
F |
|
History record ID |
|||
|
Portal ID |
|||
|
Node ID |
|||
|
Component ID |
UnknownValue |
||
|
Page ID |
UnknownValue |
UnknownValue |
|
|
Back label |
|||
|
Component mode |
UnknownValue |
UnknownValue |
|
|
Component keys |
UnknownValue |
UnknownValue |
|
|
Content URL |
|||
|
Query string parameters |
UnknownValue |
UnknownValue |
The GetBreadcrumbs function returns a Null value in the following situations:
-
When the history stack is emptyâfor example, when the function is invoked by an action on a homepage pagelet or tile.
-
When the source content is not displayed in the PeopleSoft portal templateâfor example, if you display the content in your own portal or if the content is displayed via a direct psc URL.
-
When executing JavaScript fails to retrieve any history stack data.
Note: This function cannot be invoked from a fluid component. In addition, this function cannot be invoked after the content is displayed via a direct psc URL.
Parameters
None
Returns
A array of array of string.