search string side menu

Объект для работы с рабочими календарями

Hierarchy

  • WorkCalendars

Methods

create

  • Создаёт новый рабочий календарь.

    Returns WorkCalendar

getById

  • Получить рабочий календарь по его идентификатору.

    Если календарь не найден (например, был удалён), то метод вернёт значение undefined.

    Parameters

    • id: string

      Идентификатор рабочего календаря.

    Returns Promise<WorkCalendar | undefined>

getDefault

  • Возвращает рабочий календарь «по умолчанию» — базовый календарь компании.

    Returns Promise<DefaultWorkCalendar>

getForUser

  • Получить рабочий календарь, связанный с переданным пользователем.

    Parameters

    Returns Promise<WorkCalendar>

list

  • list(size?: undefined | number, from?: undefined | number): Promise<WorkCalendar[]>

  • Получить список рабочих календарей компании.

    При работе с большим количеством календарей их можно получать порционно и динамически определять начало выборки.

    Parameters

    • Optional size: undefined | number

      Количество календарей, которое нужно получить. Значение по умолчанию 10.

    • Optional from: undefined | number

      Количество календарей, которое необходимо пропустить. Значение по умолчанию 0.

    Returns Promise<WorkCalendar[]>

setToUsers

  • Назначить рабочий календарь пользователям.

    Parameters

    Returns Promise<void>