RIO Ed - Calendar
rio_ed:timelineCalendar
| Component Name | RIO Ed - Calendar |
| API Name | rio_ed:timelineCalendar |
| Type | Bundle |
| Recommended Pages | This is bundled in RIO Ed - Student Scheduler |
| Supported In | Salesforce Internal |
| Attribute Name | API Name | Description |
| Show Calendar Navigation Header (Student Info) | showHeader | Display calendar navigation |
| First Day of Week (Student Info) | firstDay | First day of week in calendar, as a number, with the week starting on Sunday - e.g. Sunday = 0, Monday = 1, and so on |
| Calendar First Hour (Student Info) | minTime | Determines the first hour/time that will be displayed, even when scrolled to the top |
| Calendar Last Hour (Student Info) | maxTime | Determines the last hour/time (exclusively) that will be displayed, even when scrolled to the bottom |
| For faculty | isFaculty | For a faculty view, enable this, else the component will be shown from a student's perspective |
| Include Unpublished Sessions | includeUnpublishedSession | By default, unpublished sessions will not be included, but you can override this |
| Course Connection Status | courseConnectionStatus | Course Connection statuses to be shown, separated by a semi-colon - e.g, Current;Former |
| Session Connection Enrollment Status | sessionConnectionStatus | Session connection enrollment statuses to be shown, separated by a semi-colon - e.g, Current;Completed |
| Session Info Field Set |
sessionInfoFieldSet |
Session fields to display. This should be the API name of a field set on the Session object.
|
| Session Time Info Field Set | sessionTimeInfoFieldSet |
Session Time fields to display. This should be the API name of a field set on the Session Time object.
|
| Session Booking Info Field Set | sessionBookingInfoFieldSet |
Session's Booking fields to display. This should be the API name of a field set on the Booking object.
|
| Debug Mode | enableDebugMode | Enable debug mode. This should always be off in production orgs unless you are experiencing an issue. |
| Study Registration Status | studyRegistrationStatus | Study Registration statuses to be shown, separated by a semi-colon - e.g. Confirmed;Waitlisted |
|
Show Public Calendar Label Sessions |
showPublicLabelSessions |
Shows public Sessions in the calendar that match the contact public calendar labels. If enabled, then, a student will be able to see Sessions that have a matching "Public Calendar Label" value with the "Public Calendar Label" field on their Contact record. Default value: false |
| Public Calendar Label Past Day Range | publicMinDayRange |
How many days in the past to look for public sessions.
|
| Public Calendar Label Future Day Range | publicMaxDayRange |
How many days in the future to look for public sessions.
|
| Use Course Name | useCourseName |
(since 3.19) Use Course name instead of Session name for calendar events. |
| Column Header Format | columnHeaderFormat |
(since 3.20) Determines the text that will be displayed on the column headings, e.g. ddd=Mon, ddd M/D=Mon 3/18, dddd=Monday
|
| Show Week Number | showWeekNumber |
(since 3.21) Tick to show week number |
| Is ISO Week? | isIsoWeek |
(since 3.21) Tick to use ISO week number |
| Week Label Format | weekLabelFormat |
(since 3.21)
|
| Show Timezone Indicator | showTimezoneIndicator |
(since 3.21) Show an indicator of the current timezone the calendar is displayed in |
| Calendar Timezone | calendarTimezone |
(since 3.22)
By default, the calendar displays in the timezone of the current User. |