LeftPane.getList (Method)
Return zero or more structures, each containing information on the panels that are being displayed in the current user's left pane.
Returns:
LeftPane_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Enabled | NonNegativeInteger | An integer that indicates the display state of the panel (0=hidden, 1=panel, or 2=icon). |
| isFactory | Boolean | Boolean flag which when true indicates that this is a CommonSpot-provided pane and cannot be edited. |
| OwnerID | ContributorIDGroupID_0 | The ID of the left pane's owner. If the left pane is a factory pane, this value is 0. |
| SortPosition | NonNegativeInteger | The pane's sort position in the list. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| userSelector | UserSelector | Optional. Defaults to 'Current'. | Returns a user selector, which is either 'current' or 'Default'. |
| includeHidden | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot will include panels whose display state is hidden. |
Context:
| License Requirements | None |
| Permission Requirements | Contributor |
| Deny Context | None |
| Require Context | None |
| Author Lock |
Error Codes:
None
Notes:
None