- Home [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
- Getting started
- Use cases
- API
Object for working with business calendars
Hierarchy
Methods
create
Creates a new business calendar.
Returns WorkCalendar
getById
Get business calendar by its ID.
If the calendar cannot be found (for example, it has been deleted), the method returns
undefined
.Parameters
id: string
Returns Promise<WorkCalendar | undefined>
getDefault
Returns the default business calendar, that is, the basic calendar of the company.
Returns Promise<DefaultWorkCalendar>
getForUser
Get business calendar associated with the passed user.
Parameters
user: TUser
Returns Promise<WorkCalendar>
list
Get a list of business calendars of the company.
When working with a large number of calendarrs, you can get them in portions and set the start of the selection dynamically.
Parameters
Optional size: undefined | number
Optional from: undefined | number
Returns Promise<WorkCalendar[]>
setToUsers
Assign a business calendar to users.
Parameters
calendar: WorkCalendar
users: TUser[]
Optional startAt: TDate
Returns Promise<void>
Methods