RIO Ed - Calendar (Aura)
rio_ed:TimelineComponent
Table of Contents
| Component Name | RIO Ed - Calendar (Aura) |
| API Name | rio_ed:TimelineComponent |
| Type | Standalone |
| Recommended Pages | Contact page for both internal or digital experience |
| Supported In | Salesforce Internal |
This is the component behind the calendar used in the "My Sessions" page, in the Student and Faculty Communities (portals).
Supported configuration
Course Connection Enrollment Status
A new configurable option "Course Connection Enrollment Status" is added to allow admin to show the Session bookings based on the Course Connection enrollment status.
Permission needed
Developer section
| Attribute Name | API Name | Description |
| Contact Id | contactId | Optional Contact Id to use instead of logged in user. |
| Is Faculty? | isFaculty | Is this component for Faculty members only? If enabled (TRUE), the calendar will not be viewable by students on the Student Community. |
| Show View Session Button | showViewSessionButton | When the button is clicked, it will redirect you the Session's record detail. |
| Faculty can Accept and Reject Sessions | facultyCanAcceptReject | Shows the Faculty Accept and Reject buttons in the details popup (Faculty only). |
| Show Navigation Header | showHeader | Shows the header buttons to navigate and change calendar format. |
| Column Header Format | columnHeaderFormat | Determines the text that will be displayed on the column headings, e.g. ddd=Mon, ddd M/D=Mon 3/18, dddd=Monday. |
| First Day | firstDay | First day of week in calendar. Sunday=0, Monday=1. |
| Hide Today Highlight | hideTodayHighlight | Hides the Today Highlight. |
| Min Time | minTime | Calendar min time to show. Must be in 24 hour time in HH:mm:ss format e.g. 07:00:00. |
| Max Time | maxTime | Calendar max time to show. Must be in 24 hour time in HH:mm:ss format e.g. 23:00:00. |
| Respect User Timezone | respectUserTimezone | Respect timezone defined in user settings. Otherwise, local machine timezone will be used. |
| Session Info Datetime Format (Obsolete in v3.11) |
sessionInfoDateTimeFormat | Session info datetime format. Note: This is obsolete as of v3.11, as part of the Salesforce API upgrade. |
| Session Info Field Set |
sessionInfoFieldSet |
(v3.12) Session fields to display. Default = rio_ed__Timeline_CalendarInfoPopup |
| Session Time Info Field Set |
sessionTimeInfoFieldSet |
(v3.12) Session time fields to display. Default = rio_ed__Timeline_CalendarInfoPopup |
| Session Booking Info Field Set |
sessionBookingInfoFieldSet |
(v3.12) Session booking fields to display. Default = rio_ed__Timeline_CalendarInfoPopup_Session |
| Appointment Booking Info Field Set |
appointmentBookingInfoFieldSet |
(v3.12) Appointment booking fields to display. Default = rio_ed__Timeline_CalendarInfoPopup_Appointment |
| Study Registration Status |
studyRegistrationStatus |
(v3.15) Study Registration status in semi-colon separated to be considered for displaying on the calendar, e.g. Confirmed;Waitlisted. |
| Show Public Calendar Label Sessions |
showPublicLabelSessions |
(v3.15) Shows public Sessions in the calendar that match the Contact's 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 = false. |
| Public Calendar Label Past Day Range |
publicMinDayRange |
(v3.15) How many days in the past to look for public sessions. Default=90 |
| Public Calendar Label Future Day Range |
publicMaxDayRange |
(v3.15) How many days in the future to look for public sessions. Default=90 |