• Gets the details about all the weekdays for the specified calendar.

    Returns

    Array of all weekdays in the calendar.

    Example

    SimpleCalendar.api.getAllWeekdays();
    // Returns an array like this, assuming the Gregorian Calendar
    // [
    // {
    // id: "dafbfd4",
    // name: "Sunday",
    // description : "",
    // numericRepresentation: 1,
    // restday : false,
    // },
    // {
    // id: "8648c7e9",
    // name: "Monday",
    // description : "",
    // numericRepresentation: 2,
    // restday : false,
    // }
    // {
    // id: "b40f3a20",
    // name: "Tuesday",
    // description : "",
    // numericRepresentation: 3,
    // restday : false,
    // },
    // {
    // id: "6c20a99e",
    // name: "Wednesday",
    // description : "",
    // numericRepresentation: 4,
    // restday : false,
    // },
    // {
    // id: "56c14ec7",
    // name: "Thursday",
    // description : "",
    // numericRepresentation: 5,
    // restday : false,
    // },
    // {
    // id: "2c732d04",
    // name: "Friday",
    // description : "",
    // numericRepresentation: 6,
    // restday : false,
    // },
    // {
    // id: "c8f72e3d",
    // name: "Saturday",
    // description : "",
    // numericRepresentation: 7,
    // restday : false,
    // }
    // ]

    Parameters

    • calendarId: string = 'active'

      Optional parameter to specify the ID of the calendar to get the list of weekdays from. If not provided the current active calendar will be used.

    Returns WeekdayData[]