The Frame API supplies the following properties:
| Name | Type | Meaning |
| adminUrl | String | The base URL to call DLAP commands. This URL does not contain the ‘?’ character or any query parameters. |
| appVersion | String | The current application version. |
| appRoot | String | The current application root URL. This is equivalent to the <%AppRoot%> replacement tag value. |
| authenticated | Boolean | True if the end-user is authenticated; otherwise false. |
| canConference | Boolean | True if the currently authenticated user can schedule or request conferences (should have access to the Conferencing menu); otherwise false. |
| canProxy | Boolean | True if the currently authenticated user has the Proxy privilege in the current domain used for customization; otherwise false. |
| canTeachACourse | Boolean | True if the currently authenticated user has the CreateCourse and CreateSection privileges on the current domain used for customization; otherwise false. |
| catalogEntries | Object Array | Array of CatalogEntry objects that contains the catalog entries defined in the domain customization. |
| contentState | Object | A ComponentState object that contains the current state of the main frame content. In addition to the standard properties, a type property is also available, which is the lower case componentType parameter the main component passed to setComponentState |
| currentEnrollment | Object | An Enrollment object that contains information about the current enrollment context. |
| dlaptoken | String | The DLAP token for the currently authenticated user. |
| domainId | String | The ID of the current domain used for customization. |
| domainName | String | The name of the current domain used for customization. |
| enrollments | Object Array | Array of Enrollment objects that contain information about all active enrollments for the currently authenticated user. |
| frameResourceRoot | String | The current frame resource root URL segment. This is equivalent to the <%FrameResourceRoot%> replacement tag value. |
| frameRoot | String | The current frame root URL segment. This is equivalent to the <%FrameRoot%> replacement tag value. |
| homeLabel | String | Label to use for the Home link in the frame. This is set to the value in the "home" attribute of the <portal> domain customization tag. |
| isAdmin | Boolean | True if the currently authenticated user has the ReadDomain privilege on the current domain used for customization; otherwise false. |
| isProxy | Boolean | True if the currently authenticated user is proxying for another user; otherwise false. |
| menuEntries | Object Array | Array of MenuEntry objects that contains the custom menu entries defined in the domain customization. |
| proxyUserId | String | The base identifier of the currently authenticated user if the user is proxying for another user. This base identifier is the identifier of the admin user who is doing the proxying. This string is empty if the currently authenticated user is not proxying for another user. |
| proxyUsername | String | The base username of the currently authenticated user if the user is proxying for another user. It is the username of the admin user who is doing the proxying. This string is empty if the currently authenticated user is not proxying for another user. |
| proxyUserspace | String | The base userspace of the currently authenticated user if the user is proxying for another user. It is the userspace of the admin user who is doing the proxying. This string is empty if the currently authenticated user is not proxying for another user. |
| resourceRoot | String | The current resource root URL segment. This is equivalent to the <%ResourceRoot%> replacement tag value. |
| rights | Number | The domain privileges of the currently authenticated user. Possible values are documented in the RightsFlags section of the BrainHoney DLAP API Guide. |
| roles | Object Array | Array of Role objects that represent the roles defined on the current domain. |
| showBeforeUnloadPrompts | Boolean | True to allow components to show messages to the user if there is unsaved data during a browser onbeforeunload event; otherwise false. The default value is true. See also setShowBeforeUnloadPrompts. |
| userId | String | The ID of the currently authenticated user. |
| userDisplay | String | The display name of the currently authenticated user. |
| username | String | The username of the currently authenticated user. |