Help
Frame API Properties

The Frame API supplies the following properties:

Properties
NameTypeMeaning
adminUrlStringThe base URL to call DLAP commands. This URL does not contain the ‘?’ character or any query parameters.
appVersionStringThe current application version.
appRootStringThe current application root URL. This is equivalent to the <%AppRoot%> replacement tag value.
authenticatedBooleanTrue if the end-user is authenticated; otherwise false.
canConferenceBooleanTrue if the currently authenticated user can schedule or request conferences (should have access to the Conferencing menu); otherwise false.
canProxyBooleanTrue if the currently authenticated user has the Proxy privilege in the current domain used for customization; otherwise false.
canTeachACourseBooleanTrue if the currently authenticated user has the CreateCourse and CreateSection privileges on the current domain used for customization; otherwise false.
catalogEntriesObject ArrayArray of CatalogEntry objects that contains the catalog entries defined in the domain customization.
contentStateObjectA 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
currentEnrollmentObjectAn Enrollment object that contains information about the current enrollment context.
dlaptokenStringThe DLAP token for the currently authenticated user.
domainIdStringThe ID of the current domain used for customization.
domainNameStringThe name of the current domain used for customization.
enrollmentsObject ArrayArray of Enrollment objects that contain information about all active enrollments for the currently authenticated user.
frameResourceRootStringThe current frame resource root URL segment. This is equivalent to the <%FrameResourceRoot%> replacement tag value.
frameRootStringThe current frame root URL segment. This is equivalent to the <%FrameRoot%> replacement tag value.
homeLabelStringLabel 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.
isAdminBooleanTrue if the currently authenticated user has the ReadDomain privilege on the current domain used for customization; otherwise false.
isProxyBooleanTrue if the currently authenticated user is proxying for another user; otherwise false.
menuEntriesObject ArrayArray of MenuEntry objects that contains the custom menu entries defined in the domain customization.
proxyUserIdStringThe 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.
proxyUsernameStringThe 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.
proxyUserspaceStringThe 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.
resourceRootStringThe current resource root URL segment. This is equivalent to the <%ResourceRoot%> replacement tag value.
rightsNumberThe domain privileges of the currently authenticated user. Possible values are documented in the RightsFlags section of the BrainHoney DLAP API Guide.
rolesObject ArrayArray of Role objects that represent the roles defined on the current domain.
showBeforeUnloadPromptsBooleanTrue 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.
userIdStringThe ID of the currently authenticated user.
userDisplayStringThe display name of the currently authenticated user.
usernameStringThe username of the currently authenticated user.