Interface: ActivityInterface

Defined in: src/interface/activity/ActivityInterface.ts:3

Extends

• ActivityBaseInternalInterface

Properties

dateScheduling?

> readonly optional dateScheduling?: DateSchedulingInterface

Defined in: src/interface/activity/ActiveScheduling.ts:12

Used to schedule what date it will be added and removed.

Inherited from

ActivityBaseInternalInterface.dateScheduling

---

expired

> readonly expired: boolean

Defined in: src/interface/activity/ActivityInterface.ts:19

Whether the activity/commitment is a deadline, so it will then be removed or hidden.

It depends only on the date, not the time. So if you set { dateScheduling: { from: 0, to: 3 }, timeSlot { from: 10, to: 20 } } the activity/commitment hidden or deleted on date 3 at 0.

Inherited from

ActivityBaseInternalInterface.expired

---

id

> readonly id: string

Defined in: src/interface/activity/ActivityInterface.ts:9

The id of the activity/commitment.

Inherited from

ActivityBaseInternalInterface.id

---

run

> readonly run: OnRunAsyncFunction

Defined in: src/interface/activity/ActivityInterface.ts:13

The function that is called when the activity/commitment is runned.

Inherited from

ActivityBaseInternalInterface.run

---

timeSlot?

> readonly optional timeSlot?: TimeSchedulingInterface | TimeSchedulingInterface[]

Defined in: src/interface/activity/ActiveScheduling.ts:8

Time slot in which activity/commitment will be active.

Inherited from

ActivityBaseInternalInterface.timeSlot

Methods

isActive()

> isActive(options?): boolean

Defined in: src/interface/activity/ActivityInterface.ts:24

Whether the activity/commitment is active, so it will be shown in the routine and can be runned.

Parameters

options?

ActiveScheduling

The options to check if the activity/commitment is active.

Returns

boolean

Inherited from

ActivityBaseInternalInterface.isActive