ComponentState
The ComponentState object represents the state of a component, including its title and associated enrollment, course, and section. All properties are optional and may or may not be set by any given component or custom resource. Below are the properties supplied by most of the standard components. Besides the properties listed below, custom components can add any custom properties to the component state object to enable communication among custom components and frames.
Properties
| Name | Type | Meaning |
| enrollmentId | String | ID of the current enrollment of the component. |
| courseId | String | ID of the current course of the component. |
| sectionId | String | ID of the current section of the component. |
| groupId | String | ID of the current group of the component. |
| itemId | String | ID of the current content item or activity of the component. |
| studentEnrollmentId | String | ID of the student associated with the component. This will be different from enrollmentId if a teacher or administrator is viewing a component that gives details about a student. |
| helpToken | String | Help token of the component. |
| pageTitle | String | The component title. |
| subTitle1 | String | The component's first subtitle. |
| subTitle2 | String | The component's second subtitle. |
| topHeader | String | The ID of the top header to select when this component is the main content on the page. |
| subHeader | String | The ID of the first-level sub header to select when this component is the main content on the page. |
See Also